dog_biscuits 0.4.0

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

@@ -0,0 +1,13 @@
+terms:
+  - id: masters-pg
+    term: Masters (Postgraduate)
+    active: true
+  - id: diploma-pg
+    term: Diploma (Postgraduate)
+    active: true
+  - id: bachelors-ug
+    term: Bachelors (Undergraduate)
+    active: true
+  - id: doctoral-pg
+    term: Doctoral (Postgraduate)
+    active: true

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

@@ -0,0 +1,31 @@
+terms:
+  - id: ba
+    term: Bachelor of Arts (BA)
+    active: true
+  - id: bphil
+    term: Bachelor of Philosophy (BPhil)
+    active: true
+  - id: bsc
+    term: Bachelor of Science (BSc)
+    active: true
+  - id: ma
+    term: Master of Arts (MA)
+    active: true
+  - id: mres
+    term: Master of Arts by Research (MRes)
+    active: true
+  - id: mphil
+    term: Master of Philosophy (MPhil)
+    active: true
+  - id: mres
+    term: Master of Research (MRes)
+    active: true
+  - id: msc
+    term: Master of Science (MSc)
+    active: true
+  - id: mres-s
+    term: Master of Science by Research (MRes)
+    active: true
+  - id: phdip
+    term: Postgraduate Diploma (PGDip)
+    active: true

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

@@ -0,0 +1,47 @@
+# DataCite Resource Type General
+terms:
+  - id: http://www.w3.org/ns/dcat#MovingImage
+    term: Audiovisual
+    active: true
+  - id: http://www.w3.org/ns/dcat#Collection
+    term: Collection
+    active: true
+  - id: https://schema.datacite.org/resource_type_general/DataPaper
+    term: Data Paper
+    active: true
+  - id: http://www.w3.org/ns/dcat#Dataset
+    term: Dataset
+    active: true
+  - id: http://www.w3.org/ns/dcat#Event
+    term: Event
+    active: true
+  - id: http://www.w3.org/ns/dcat#StillImage
+    term: Image
+    active: true
+  - id: http://www.w3.org/ns/dcat#InteractiveResource
+    term: Interactive Resource
+    active: true
+  - id: http://purl.org/spar/fabio/Model
+    term: Model
+    active: true
+  - id: http://www.w3.org/ns/dcat#PhysicalObject
+    term: Physical Object
+    active: true
+  - id: http://www.w3.org/ns/dcat#Service
+    term: Service
+    active: true
+  - id: http://www.w3.org/ns/dcat#Software
+    term: Software
+    active: true
+  - id: http://www.w3.org/ns/dcat#Sound
+    term: Sound
+    active: true
+  - id: http://www.w3.org/ns/dcat#Text
+    term: Text
+    active: true
+  - id: http://purl.org/spar/fabio/Workflow
+    term: Workflow
+    active: true
+  - id: http://purl.org/vocab/frbr/core#Endeavour
+    term: Other
+    active: true

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

@@ -0,0 +1,3 @@
+# authorities
+
+dog_biscuits: 'true'

data/lib/generators/dog_biscuits/templates/config/initializers/catalog_search_builder_overrides.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# ./config/initializers/catalog_search_builder_overrides.rb
+# via https://github.com/samvera/hyrax/issues/707
+
+# Unclear how to customize the Sufia::CatalogSearchBuilder, which
+# we need to do for blacklight_range_limit.
+# https://github.com/projecthydra-labs/hyrax/issues/707
+
+# to_prepare used in case there's dev-mode class reloading of the
+# thing we're patching. But we try to check to not do it multiple
+# times in case there isn't.
+Rails.application.config.to_prepare do
+  # would like to look up the class dynamically in case it changes,
+  # Sufia does this weird making this the only way, Hyrax is somewhat
+  # less weird.
+  klass = CatalogController.new.search_builder_class
+  klass.send(:include, BlacklightRangeLimit::RangeLimitBuilder) unless klass.ancestors.include? BlacklightRangeLimit::RangeLimitBuilder
+end

data/lib/generators/dog_biscuits/templates/config/initializers/dog_biscuits.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+# load dog_biscuits config
+DOGBISCUITS = YAML.safe_load(File.read(Rails.root.join('config', 'dog_biscuits.yml'))).with_indifferent_access
+# include Terms
+
+# Configuration
+DogBiscuits.config do |config|
+  # GLOBAL PROPERTIES
+
+  # Models to be used in the current application.
+  #   Available models are:
+  #   Add values in constantized form, eg. 'ConferenceItem'
+  # config.selected_models = []
+
+  # Use the blacklight date range gem to provide a single combined range filter
+  #   default = false
+  #   nb. run rails g dog_biscuits:dates_generator to install
+  # config.date_range = true
+
+  # Use the bootstrap date picker for date fields
+  #   default = false
+  #   nb. run rails g dog_biscuits:dates_generator to install
+  # config.date_picker = true
+
+  # Date fields on which to apply the date picker
+  #   default is everything in the date_properties config
+  #   Add values as symbols (eg. :date_created)
+  # config.date_picker_dates += [] # add to the list
+  # config.date_picker_dates -= [] # remove from the list
+  # config.date_picker_dates += [] # replace the current list
+
+  # Date fields to be indexed into the date_range facet:
+  #   Add values as symbols (eg. :date_created)
+  # config.date_properties += [] # add to the list
+  # config.date_properties -= [] # remove from the list
+  # config.date_properties += [] # replace the current list
+
+  # Solr fields that will be used as facets in the search page.
+  #   The ordering of the field names is the order of the display
+  #   The properties must have been indexed as facetable
+  #   Add values as symbols (eg. :creator)
+  # config.facet_properties += [] # add to the end of the current list
+  # config.facet_properties -= [] # remove from the current list
+  # config.facet_properties = [] # replace the current list
+
+  # Solr fields to be displayed in the index (search results) view
+  #   The ordering of the field names is the order of the display
+  #   Add values as symbols (eg. :creator)
+  # config.index_properties += [] # add to the end of the current list
+  # config.index_properties -= [] # remove from the current list
+  # config.index_properties = [] # replace the current list
+
+  # Solr fields to exclude from search
+  #   Add values as symbols (eg. :creator)
+  # config.exclude_from_search_properties += [] # add to the end of the current list
+  # config.exclude_from_search_properties -= [] # remove from the current list
+  # config.exclude_from_search_properties = [] # replace the current list
+
+  # Fields in the form that should only accept a single value, ie. disable the 'add another' button.
+  #   Add values as symbols (eg. :creator)
+  # config.singular_properties += [] # add to the list
+  # config.singular_properties -= [] # remove from the list
+  # config.singular_properties += [] # replace the current list
+
+  # Date properties
+  # These will be indexed into the date_picker if present
+  # config.date_properties += []
+  
+  # Enable restricted properties in the form. 
+  # If set to false, no restrictions will be applied
+  # Default is false
+  # config.restricted_properties_enabled = false
+  
+  # Restrict the following properties in the form to the role specified in
+  #   restricted_role
+  # Restrictions apply to 'below the fold' properties only, they are not
+  #   applied to required properties
+  # Restrictions apply in the form only, properties are still visible in the
+  #   show page
+  # Required current_user to respond to the role ( current_user.admin? )
+  #   this is provided by the 'hydra-role-management' gem
+  # config.restricted_properties_enabled? must be set to true for this to take effect
+  # config.restricted_properties = []
+
+  # Role to use when restricting properties
+  # Default is :admin
+  # config.restricted_role = :admin
+
+  # Add values that aren't found in the following table-based authorities to be added on save.
+  #   This only works in cases where the name of the authority is a pluralized form of
+  #   the name of the property which uses it, eg. subjects/subject and languages/language
+  # Default is :subjects; add authority name as symbol, eg. :subjects
+  # config.authorities_add_new = []
+
+  # WORK PROPERTIES
+
+  # For each model, there are two configurations available.
+  # Both are set to defaults:
+  #    _required fields defaults to the Hyrax default (title, creator, keyword, rights_statment)
+  #    _properties defaults to all properties available to that model, alphabetized
+  #  Example:
+  #    config.conference_item_properties = []
+  #    config.conference_item_properties_required = []
+
+  # PROPERTY MAPPINGS
+  # All properties should be included in property_mappings. This is used by generators for building
+  #   schema_org, locales, catalog_controller and attribute_rows. Adding info here and using
+  #   generators saves on a lot of manual editing.
+  #
+  # To add a new local property (new_property below), do:
+  #   config.property_mappings[:new_property] = {}
+  #
+  # To change an existing property (existing_property), do:
+  #   config.property_mappings[:existing_property] = {}
+  #
+  # The contents of a property_mappings key:
+  #
+  #   config.property_mappings[:existing_property] =
+  #     {
+  #       # REQUIRED (if the property will appear in search results): a string formatted as per the example shown
+  #       index: "('existing_property', :stored_searchable)",
+  #
+  #       # OPTIONAL: label for use in the form, show page, search results and facet
+  #       label: 'My Property Label',
+  #
+  #       # OPTIONAL: help_text for use in the form
+  #       help_text: 'Use this to describe something or other',
+  #
+  #       # OPTIONAL: reference to a renderer used to format the display of the text in the show page
+  #       # in this eg. `app/renderers/existing_property_attribute_renderer.rb` must exist
+  #       render_as: 'existing_property',
+  #
+  #       # OPTIONAL reference to a helper method used to format the display of the text in the search results
+  #       # in this eg. the `existing_property_helper` method must exist in app/helpers, eg. in hyrax_helper.rb
+  #       helper_method: 'existing_property_helper',
+  #
+  #       # OPTIONAL mapping to a schema.org property to be used in embedded metadata
+  #       schema_org: {
+  #         # in this eg. we have decided that the closest property match in schema.org is contributor
+  #         property: 'contributor'
+  #     }
+  # }
+end

data/lib/generators/dog_biscuits/templates/dog_biscuits.en.yml.erb

@@ -0,0 +1,11 @@
+en:
+  dog_biscuits:
+    labels:<% DogBiscuits.config.all_properties.sort.each {|prop| if DogBiscuits.config.property_mappings[prop] && DogBiscuits.config.property_mappings[prop][:label] %>
+      <%= prop %>: <%= DogBiscuits.config.property_mappings[prop][:label] %><% end } %>
+  simple_form:
+    hints:
+      defaults:<% DogBiscuits.config.all_properties.sort.each {|prop| if DogBiscuits.config.property_mappings[prop] && DogBiscuits.config.property_mappings[prop][:help_text] %>
+        <%= prop %>: <%= DogBiscuits.config.property_mappings[prop][:help_text] %><% end } %> 
+    labels:
+      defaults:<% DogBiscuits.config.all_properties.sort.each {|prop| if DogBiscuits.config.property_mappings[prop] && DogBiscuits.config.property_mappings[prop][:label] %>
+        <%= prop %>: <%= DogBiscuits.config.property_mappings[prop][:label] %><% end } %>

data/lib/generators/dog_biscuits/templates/schema_org.yml.erb

@@ -0,0 +1,4 @@
+schema_org:<% DogBiscuits.config.all_properties.sort.each { | prop | if DogBiscuits.config.property_mappings[prop] && DogBiscuits.config.property_mappings[prop][:schema_org] %>
+  <%= prop.to_s %>:
+    <% DogBiscuits.config.property_mappings[prop][:schema_org].each { |k, v| %><%= k %>: <%= v %>
+    <% } end } %>

data/lib/generators/dog_biscuits/work/USAGE

@@ -0,0 +1,35 @@
+Description:
+    The DogBiscuits Work generator makes the following changes to your application:
+    1. Checks that the requested Work is supported by DogBiscuits
+    2. Runs the Hyrax generator for the given model
+    3. Creates a new model, form, presenter and indexer to replace the Hyrax one
+    4. Creates views/hyrax/work_name_plural/_attribute_rows.html.erb
+    5. Updates the schema_org config, hyrax (en) locale using the configured properties for the work
+
+Example:
+    rails generate dog_biscuits:work ConferenceItem
+
+Making changes post-generation:
+    You can make most of the changes you'll need (property selection, order, required etc.)
+      in config/initializers/dog_biscuits.rb. You do not need to re-run the generator 
+      for these changes to take effect.
+    If you have changed labels, help_text or schema_org mappings in the property_mappings config:
+      re-run the locales generator with `rails g dog_biscuits:locales`
+      re-run the schema_org generator with `rails g dog_biscuits:schema_org`
+
+Adding local properties
+    Add the local property into the model (in app/models/)
+    Add an attribute into the solr_document (app/models/solr_document.rb)
+    Add the property to the config (config/initializers/dog_biscuits.rb)
+
+    Add custom helper methods or renderers (in app/helpers/ and app/renderers)
+      and add them to the property_mappings.
+
+    The generator can be re-run without overwriting the model and indexer files using the --skipmodel option
+      although, as noted above, you should not need to re-run the generator
+
+Example:
+    rails generate dog_biscuits:work ConferenceItem --skipmodel
+      or (to update only labels, help_text and schema_org mappings)
+    rails g dog_biscuits:locales
+    rails g dog_biscuits:schema_org

data/lib/generators/dog_biscuits/work/templates/README

@@ -0,0 +1,31 @@
+===============================================================================
+
+After creating your work you may wish to:
+
+  1. Customize the Work (the 'dog_biscuits way'):
+
+  in config/initializers/dog_biscuits.rb change the defaults:
+
+    fields to display in search results:
+      config.index_properties
+
+    fields to display as facets:
+      config.facet_properties
+
+    properties and order in the form and show page:
+      config.your_work_properties
+
+    required fields in the form
+      config.your_work_properties_required
+      
+    Restart your application to see changes take effect.
+  
+  2. Further modify the model, indexer, actor, form or presenter
+
+  Remember that if you re-run the Work generator, select 'n' if you have made local changes:
+    rails g dog_biscuits:work Work
+  
+  You can ensure the model and indexer are not overwritten with the --skipmodel flag
+    rails g dog_biscuits:work Work --skipmodel
+
+===============================================================================

data/lib/generators/dog_biscuits/work/templates/_attribute_rows.html.erb

@@ -0,0 +1,22 @@
+<% DogBiscuits.config.send("#{presenter.model_name.singular}_properties").each do | prop |
+  # skip title, description and license
+  next if [:title, :description, :license].include? prop
+  
+  prop = "#{prop}_label".to_sym if presenter.model_name.to_s.constantize.controlled_properties.include? prop
+
+  if DogBiscuits.config.property_mappings[prop]
+    if DogBiscuits.config.property_mappings[prop][:render_as]
+      render = DogBiscuits.config.property_mappings[prop][:render_as]
+    elsif DogBiscuits.config.facet_properties.include? prop
+      render = 'faceted'
+    else
+      render = nil
+    end
+  end %>
+  <%= presenter.attribute_to_html(prop, 
+    label: I18n.t("dog_biscuits.labels.#{prop.to_s}"),
+    render_as: render, 
+    html_dl: true) 
+  %>
+<% end %>
+

data/lib/generators/dog_biscuits/work/templates/actor.rb.erb

@@ -0,0 +1,25 @@
+# Generated via
+#  `rails generate hyrax:work <%= class_name %>`
+module Hyrax
+  module Actors
+    class <%= class_name %>Actor < Hyrax::Actors::BaseActor
+      include DogBiscuits::Actors::ApplyAuthorities
+      include DogBiscuits::Actors::SingularAttributes
+
+      # @param [Hyrax::Actors::Environment] env
+      # @return [Boolean] true if create was successful
+      def create(env)
+        apply_authorities(env)
+        super
+      end
+
+      # @param [Hyrax::Actors::Environment] env
+      # @return [Boolean] true if update was successful
+      def update(env)
+        apply_authorities(env)
+        super
+      end
+
+    end
+  end
+end

data/lib/generators/dog_biscuits/work/templates/form.rb.erb

@@ -0,0 +1,18 @@
+# Generated via
+#  `rails generate dog_biscuits:work <%= class_name %>`
+module Hyrax
+  class <%= class_name %>Form < Hyrax::Forms::WorkForm
+    self.model_class = <%= class_name %>
+
+    self.terms -= DogBiscuits.config.base_properties
+    self.terms += DogBiscuits.config.<%= file_name %>_properties
+
+    # Add any local properties here
+    self.terms += []
+
+    self.required_fields = DogBiscuits.config.<%= file_name %>_properties_required
+
+    # The service that determines the cardinality of each field
+    self.field_metadata_service = ::LocalFormMetadataService
+  end
+end

data/lib/generators/dog_biscuits/work/templates/indexer.rb.erb

@@ -0,0 +1,23 @@
+# Generated via
+#  `rails generate dog_biscuits:work <%= class_name %>`
+class <%= class_name %>Indexer < DogBiscuits::<%= class_name %>Indexer
+  # This indexes the default metadata. You can remove it if you want to
+  # provide your own metadata and indexing.
+  # include Hyrax::IndexesBasicMetadata
+
+  # Fetch remote labels for based_near. You can remove this if you don't want
+  # this behavior
+  # include Hyrax::IndexesLinkedMetadata
+
+  # Uncomment this block if you want to add custom indexing behavior:
+  # def generate_solr_document
+  #  super.tap do |solr_doc|
+  #    solr_doc['my_custom_field_ssim'] = object.my_custom_property
+  #  end
+  # end
+
+  # Fetch remote labels for based_near. Copied from Hyrax::IndexesLinkedMetadata
+  def rdf_service
+    Hyrax::DeepIndexingService
+  end
+end