dog_biscuits 0.4.0

data/lib/generators/dog_biscuits/templates/_date_template.html.erb

@@ -0,0 +1,7 @@
+<% # use date picker %>
+
+<% if f.object.class.multiple? key %>
+    <%= f.input key, as: :multi_value, input_html: { data: { provide: 'datepicker', 'date-force-parse': 'false', 'date-autoclose': 'true' } }, required: f.object.required?(key) %>
+<% else %>
+  <%= f.input key, input_html: { value: f.object.model[key].first, data: { provide: 'datepicker', 'date-force-parse': 'false', 'date-autoclose': 'true' } }, required: f.object.required?(key) %>
+<% end %>

data/lib/generators/dog_biscuits/templates/app/controllers/catalog_controller.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+# Override of default CatalogController, generated by DogBiscuits
+#   Based on code from JiscRDSS/rdss-samvera
+#   https://github.com/JiscRDSS/rdss-samvera/blob/master/willow/app/controllers/catalog_controller.rb
+#   Copyright Jisc
+class CatalogController < ApplicationController
+  include Hydra::Catalog
+  include Hydra::Controller::ControllerBehavior
+  include DogBiscuits::Blacklight::Commands
+
+  # This filter applies the hydra access controls
+  before_action :enforce_show_permissions, only: :show
+
+  def self.uploaded_field
+    solr_name('system_create', :stored_sortable, type: :date)
+  end
+
+  def self.modified_field
+    solr_name('system_modified', :stored_sortable, type: :date)
+  end
+
+  configure_blacklight do |config|
+    config.search_builder_class = Hyrax::CatalogSearchBuilder
+
+    # Show gallery view
+    config.view.gallery.partials = [:index_header, :index]
+    config.view.slideshow.partials = [:index]
+
+    ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
+    config.default_solr_params = {
+      qt: 'search',
+      rows: 10,
+      qf: to_searchable_names_field_list([:title,
+                                          :description,
+                                          :creator,
+                                          :keyword])
+    }
+
+    # solr field configuration for document/show views
+    config.index.title_field = solr_name(:title, :stored_searchable)
+    config.index.display_type_field = solr_name(:has_model, :symbol)
+    config.index.thumbnail_field = 'thumbnail_path_ss'
+
+    # solr fields that will be treated as facets by the blacklight application
+    #   The ordering of the field names is the order of the display
+    facet_props = DogBiscuits.config.facet_properties
+    add_facet_field config, facet_props
+    
+    # Add the date_range facet if configured
+    if DogBiscuits.config.date_range == true
+      config.add_facet_field solr_name('date_range', :facetable), label: default_label(:date_range), range: true
+    end
+
+    # The generic_type isn't displayed on the facet list
+    # It's used to give a label to the filter that comes from the user profile
+    config.add_facet_field solr_name("generic_type", :facetable), if: false
+
+    # Have BL send all facet field names to Solr, which has been the default
+    # previously. Simply remove these lines if you'd rather use Solr request
+    # handler defaults, or have no facets.
+    config.add_facet_fields_to_solr_request!
+
+    # solr fields to be displayed in the index (search results) view
+    #   The ordering of the field names is the order of the display
+
+    index_props = DogBiscuits.config.index_properties.collect do |prop|
+      { prop => index_options(prop, DogBiscuits.config.property_mappings[prop]) }
+    end
+    add_index_field config, index_props
+
+    # solr fields to be displayed in the show (single result) view
+    #   The ordering of the field names is the order of the display
+    show_props = DogBiscuits.config.all_properties
+    add_show_field config, show_props
+
+    # "fielded" search configuration. Used by pulldown among other places.
+    # For supported keys in hash, see rdoc for Blacklight::SearchFields
+    #
+    # Search fields will inherit the :qt solr request handler from
+    # config[:default_solr_parameters], OR can specify a different one
+    # with a :qt key/value. Below examples inherit, except for subject
+    # that specifies the same :qt as default for our own internal
+    # testing purposes.
+    #
+    # The :key is what will be used to identify this BL search field internally,
+    # as well as in URLs -- so changing it after deployment may break bookmarked
+    # urls.  A display label will be automatically calculated from the :key,
+    # or can be specified manually to be different.
+    #
+    # This one uses all the defaults set by the solr request handler. Which
+    # solr request handler? The one set in config[:default_solr_parameters][:qt],
+    # since we aren't specifying it otherwise.
+    config.add_search_field('all_fields', label: 'All Fields') do |field|
+      all_names = config.show_fields.values.reject do |v|
+        DogBiscuits.config.exclude_from_search_properties.include?(v)
+      end.map(&:field).join(" ")
+      title_name = solr_name(:title, :stored_searchable)
+      field.solr_parameters = {
+        qf: "#{all_names} file_format_tesim all_text_timv",
+        pf: title_name.to_s
+      }
+    end
+
+    # Now we see how to over-ride Solr request handler defaults, in this
+    # case for a BL "search field", which is really a dismax aggregate
+    # of Solr search fields.
+    add_search_field config, DogBiscuits.config.all_properties.reject { |v|
+      DogBiscuits.config.exclude_from_search_properties.include?(v)
+    }
+
+    # "sort results by" select (pulldown)
+    # label in pulldown is followed by the name of the SOLR field to sort by and
+    # whether the sort is ascending or descending (it must be asc or desc
+    # except in the relevancy case).
+    # label is key, solr field is value
+    config.add_sort_field "score desc, #{uploaded_field} desc", label: "relevance"
+    config.add_sort_field "#{uploaded_field} desc", label: "date uploaded \u25BC"
+    config.add_sort_field "#{uploaded_field} asc", label: "date uploaded \u25B2"
+    config.add_sort_field "#{modified_field} desc", label: "date modified \u25BC"
+    config.add_sort_field "#{modified_field} asc", label: "date modified \u25B2"
+
+    # If there are more than this many search results, no spelling ("did you
+    # mean") suggestion is offered.
+    config.spell_max = 5
+  end
+
+  # disable the bookmark control from displaying in gallery view
+  # Hyrax doesn't show any of the default controls on the list view, so
+  # this method is not called in that context.
+  def render_bookmarks_control?
+    false
+  end
+end

data/lib/generators/dog_biscuits/templates/app/helpers/dog_biscuits_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module DogBiscuitsHelper
+  # Return the label for publication status
+  #
+  # @param value [String]
+  # @return [String]
+  def publication_status(value)
+    if value.is_a? String
+      publication_status_label(status)
+    elsif value.is_a? Hash
+      value[:value].map { |status| publication_status_label(status) }
+    end
+  end
+
+  def publication_status_label(value)
+    service = AuthorityService::PublicationStatusesService.new
+    service.label(value)
+  rescue KeyError
+    value
+  end
+
+  def truncate_text_and_iconify_link(value)
+    if value.is_a? String
+      iconify_auto_link(truncate_text(value).to_s)
+    elsif value.is_a? Hash
+      value[:value] = value[:value].map { |text| truncate_text(text).to_s }
+      iconify_auto_link(value)
+    end
+  end
+
+  def truncate_text(text)
+    text.truncate_words(50, omission: ' ...')
+  end
+  
+  def restricted?(term)
+    return false if DogBiscuits.config.restricted_properties_enabled == false
+    # evaluate restriction
+    (
+      DogBiscuits.config.restricted_properties.include?(term) && 
+        current_user.send("#{DogBiscuits.config.restricted_role}?") == true
+    ) || !DogBiscuits.config.restricted_properties.include?(term)
+  end
+end

data/lib/generators/dog_biscuits/templates/app/renderers/package_ids_renderer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class PackageIdsRenderer < Hyrax::Renderers::AttributeRenderer
+  # Render the bibilionumber as a link to the King's Fund Library Catalogue record
+  def attribute_value_to_html(value)
+    object = ActiveFedora::Base.find(value)
+
+    link_to(
+      "<span class='glyphicon'></span>#{object.first_title}".html_safe,
+      "/concern/#{object.class.to_s.pluralize.underscore}/#{value}"
+    )
+  end
+end

data/lib/generators/dog_biscuits/templates/app/renderers/packaged_by_ids_renderer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class PackagedByIdsRenderer < Hyrax::Renderers::AttributeRenderer
+  # Render the bibilionumber as a link to the King's Fund Library Catalogue record
+  def attribute_value_to_html(value)
+    link_to(
+      "<span class='glyphicon'></span>#{Package.find(value).first_title}".html_safe,
+      "/concern/packages/#{value}"
+    )
+  end
+end

data/lib/generators/dog_biscuits/templates/app/renderers/publication_status_renderer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+class PublicationStatusRenderer < Hyrax::Renderers::AttributeRenderer
+  include DogBiscuitsHelper
+
+    private
+
+      def li_value(value)
+        link_to(ERB::Util.h(publication_status_label(value)), search_path(value))
+      end
+
+      def search_path(value)
+        Rails.application.routes.url_helpers.search_catalog_path(
+          'f([publication_status_sim[]])': ERB::Util.h(value), locale: I18n.locale
+        )
+      end
+end

data/lib/generators/dog_biscuits/templates/app/services/concerns/file_authority_concern.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FileAuthorityConcern
+  extend ActiveSupport::Concern
+  included do
+    def include_current_value(value, _index, render_options, html_options)
+      unless value.blank? || active?(value)
+        html_options[:class] << ' force-select'
+        render_options += [[label(value), value]]
+      end
+      [render_options, html_options]
+    end
+  end
+end

data/lib/generators/dog_biscuits/templates/app/services/concerns/local_authority_concern.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module LocalAuthorityConcern
+  extend ActiveSupport::Concern
+  included do
+    def initialize
+      super
+    end
+
+    def include_current_label(value, _index, render_options, html_options)
+      if value.present?
+        html_options[:class] << ' force-select'
+        render_options += [[find_label_string(value).join, value]]
+      end
+      [render_options, html_options]
+    end
+  end
+end

data/lib/generators/dog_biscuits/templates/app/services/local_form_metadata_service.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# Answers queries about the cardinality of each field on the form.
+class LocalFormMetadataService < Hyrax::FormMetadataService
+  # @param [Class] model_class the class of the object
+  # @param [Symbol] field the field we want to know about
+  # @return [Boolean] true if the passed in field is a multivalued field
+  def self.multiple?(model_class, field)
+    if DogBiscuits.config.singular_properties.include? field
+      false
+    else
+      # Inquire at the model level
+      super
+    end
+  end
+end

data/lib/generators/dog_biscuits/templates/app/views/hyrax/base/_form_metadata.html.erb

@@ -0,0 +1,23 @@
+<div class="base-terms">
+  <% f.object.primary_terms.each do |term| %>
+    <%= render_edit_field_partial(term, f: f) %>
+  <% end %>
+</div>
+<% if f.object.display_additional_fields? %>
+  <%= link_to t('hyrax.works.form.additional_fields'),
+      '#extended-terms',
+      class: 'btn btn-default additional-fields',
+      data: { toggle: 'collapse' },
+      role: "button",
+      'aria-expanded'=> "false",
+      'aria-controls'=> "extended-terms" %>
+  <div id="extended-terms" class='collapse'>
+    <%= render 'form_media', f: f %>
+    <% f.object.secondary_terms.each do |term| %>
+      <%# override partial from Hyrax, restricted_properties control %>
+      <% if restricted?(term) %>
+        <%= render_edit_field_partial(term, f: f) %>
+      <% end %>
+    <% end %>
+  </div>
+<% end %>

data/lib/generators/dog_biscuits/templates/app/views/records/edit_fields/_abstract.html.erb

@@ -0,0 +1,5 @@
+<% if f.object.multiple? key %>
+  <%= f.input :abstract, as: :multi_value, input_html: { rows: '14', type: 'textarea'}, required: f.object.required?(key) %>
+<% else %>
+  <%= f.input :abstract, as: :text, input_html: { rows: '14' }, required: f.object.required?(key) %>
+<% end %>

data/lib/generators/dog_biscuits/templates/app/views/records/edit_fields/_default.html.erb

@@ -0,0 +1,6 @@
+<% # the hyrax version of this file messes singular field display %>
+<% if f.object.class.multiple? key %>
+  <%= f.input key, as: :multi_value, input_html: { class: 'form-control' }, required: f.object.required?(key) %>
+<% else %>
+  <%= f.input key, required: f.object.required?(key), input_html: { value: f.object.model[key].first } %>
+<% end %>

data/lib/generators/dog_biscuits/templates/app/views/records/edit_fields/_funder.html.erb

@@ -0,0 +1,8 @@
+<%= f.input key,
+            as: :multi_value,
+            input_html: {
+              class: 'form-control',
+              data: { 'autocomplete-url' => "/authorities/search/crossref/funders",
+                      'autocomplete' => key }
+            },
+            required: f.object.required?(key) %>

data/lib/generators/dog_biscuits/templates/app/views/records/edit_fields/_note.html.erb

@@ -0,0 +1,5 @@
+<% if f.object.multiple? key %>
+  <%= f.input :note, as: :multi_value, input_html: { rows: '14', type: 'textarea'}, required: f.object.required?(key) %>
+<% else %>
+  <%= f.input :note, as: :text, input_html: { rows: '14' }, required: f.object.required?(key) %>
+<% end %>

data/lib/generators/dog_biscuits/templates/app/views/records/edit_fields/_part_of.html.erb

@@ -0,0 +1,17 @@
+<% if f.object.class.to_s.include? 'JournalArticle' %>
+    <%= f.input key,
+                as: :multi_value,
+                input_html: {
+                    class: 'form-control',
+                    data: {'autocomplete-url' => "/authorities/search/crossref/journals",
+                        'autocomplete' => key},
+                },
+                required: f.object.required?(key)
+    %>
+<% else %>
+    <% if f.object.multiple? key %>
+        <%= f.input key, as: :multi_value, input_html: { class: 'form-control' }, required: f.object.required?(key) %>
+        <% else %>
+        <%= f.input key, required: f.object.required?(key) %>
+    <% end %>
+<% end %>

data/lib/generators/dog_biscuits/templates/app/views/records/edit_fields/_publication_status.html.erb

@@ -0,0 +1,6 @@
+<% ps_service = AuthorityService::PublicationStatusesService.new %>
+<%= f.input :publication_status,
+            collection: ps_service.select_active_options,
+            include_blank: true,
+            item_helper: ps_service.method(:include_current_value),
+            input_html: {class: 'form-control', multiple: false} %>

data/lib/generators/dog_biscuits/templates/app/views/records/edit_fields/_refereed.html.erb

@@ -0,0 +1,5 @@
+<% val = nil %>
+<% val = ['Yes', true] if f.object.model[key].first == 'Yes' %>
+<% val = ['No', false] if f.object.model[key].first == 'No' %>
+
+<%= f.input key, as: :radio_buttons, collection: [ ['Yes', 'Yes'], ['No', 'No'] ], checked: val %>

data/lib/generators/dog_biscuits/templates/app/views/records/edit_fields/_resource_type_general.html.erb

@@ -0,0 +1,2 @@
+<%= f.input :resource_type_general, as: :select, collection: AuthorityService::ResourceTypeGeneralsService.new.select_active_options,
+    input_html: { class: 'form-control', multiple: true } %>

data/lib/generators/dog_biscuits/templates/authority_service.rb.erb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module AuthorityService
+  # Object based
+  <% ::DogBiscuits::Terms.constants.each do |term| %>
+  class <%=term.to_s.gsub('Terms', '')%>Service < DogBiscuits::Terms::<%=term.to_s%>
+    include ::LocalAuthorityConcern
+  end
+  <% end %>
+  # File based
+  <% Dir.entries('config/authorities').each do |file|
+    next unless file.end_with?('.yml') %>
+  class <%=file.gsub('.yml', '').camelize%>Service < Hyrax::QaSelectService
+    include ::FileAuthorityConcern
+    
+    def initialize
+      super('<%=file.gsub('.yml', '')%>')
+    end
+  end
+  <% end %>
+
+  # Table based
+  class TableBasedAuthorityService < DogBiscuits::TableBasedAuthorityExtended
+  end
+end

data/lib/generators/dog_biscuits/templates/config/authorities/content_versions.yml

@@ -0,0 +1,25 @@
+terms:
+  - id: AO
+    term: Author's Original
+    active: true
+  - id: SMUR
+    term: Submitted Manuscript Under Review
+    active: true
+  - id: AM
+    term: Accepted Manuscript
+    active: true
+  - id: P
+    term: Proof
+    active: true
+  - id: VoR
+    term: Version of Record
+    active: true
+  - id: CVoR
+    term: Corrected Version of Record
+    active: true
+  - id: EVoR
+    term: Enhanced Version of Record
+    active: true
+  - id: NA
+    term: Not Applicable (or Unknown)
+    active: true

data/lib/generators/dog_biscuits/templates/config/authorities/publication_statuses.yml

@@ -0,0 +1,19 @@
+terms:
+  - id: published
+    term: Published
+    active: true
+  - id: earlyonline
+    term: E-Pub ahead of publication
+    active: true
+  - id: accepted
+    term: Accepted
+    active: true
+  - id: submitted
+    term: Submitted
+    active: true
+  - id: inpress
+    term: In Press
+    active: true
+  - id: unpublished
+    term: Unpublished
+    active: true