dog_biscuits 0.4.0

data/Gemfile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dog_biscuits.gemspec
+gemspec
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 1.1.0
+# engine_cart stanza: 0.10.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
+
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'coffee-rails', '~> 4.1.0'
+    gem 'responders', '~> 2.0'
+    gem 'sassc'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
+  end
+end
+# END ENGINE_CART BLOCK

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright 2017 University of London and University of York
+Additional copyright may be held by others, as reflected in the commit history.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,98 @@
+# DogBiscuits
+
+Code: [![Build Status](https://travis-ci.org/samvera-labs/dog_biscuits.svg?branch=cleanup)](https://travis-ci.org/samvera-labs/dog_biscuits)
+[![Coverage Status](https://coveralls.io/repos/github/samvera-labs/dog_biscuits/badge.svg?branch=master)](https://coveralls.io/github/samvera-labs/dog_biscuits?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/10912dcb2451a6c4490c/maintainability)](https://codeclimate.com/github/samvera-labs/dog_biscuits/maintainability)
+[![Inline docs](http://inch-ci.org/github/samvera-labs/dog_biscuits.svg?branch=master)](http://inch-ci.org/github/samvera-labs/dog_biscuits)
+[![Gem Version](https://badge.fury.io/rb/dog_biscuits.svg)](https://badge.fury.io/rb/dog_biscuits)
+
+Docs: 
+[![Documentation](http://img.shields.io/badge/DOCUMENTATION-wiki-blue.svg)](https://github.com/samvera-labs/dog_biscuits/wiki)
+[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+
+Models, vocabularies and behaviours for Hyrax applications :dog: :cookie:
+
+## Product Owner
+
+Julie Allinson [geekscruff](https://github.com/geekscruff)
+
+## Installation
+
+For use within [Hyrax 2](https://github.com/samvera/hyrax) applications. 
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dog_biscuits', :git => 'git://github.com/geekscruff/dog_biscuits.git'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dog_biscuits
+
+Run the generator
+
+    $ rails generate dog_biscuits:install
+    
+The installer adds some new field templates in `views/hyrax/records/edit_fields`:
+
+* abstract - show as a paragraph
+* funder - use the crossref fundref autosuggest service
+* note - show as a paragraph
+* part_of - for JournalArticle use the crossref journals autosuggest service
+* publication_status - use a file_based authority (from config/authorities)
+* refereeed - show radio buttons for Yes and No
+* resource_type_general - use a file_based authority (from config/authorities)
+
+Removing these will default back to standard text field display
+
+## Generate Works
+
+Run the work generator
+
+    $ rails generate dog_biscuits:work WorkName
+    
+If the work is not supported, the generator will give you a list of supported models.
+
+Add the --skipmodel flag leave the model and indexer unchanged (eg. when you have custom properties in the model and/or custom indexing).
+
+## Configure Works
+
+Edit `config/initializers/dog_biscuits.rb` to configure the properties used by your work - see the comments in that file for details.
+
+## Dates
+
+### Date slider in search results
+
+Add `blacklight_range_limit` by setting the following flag in `config/initializers/dog_biscuits.rb`:
+
+```
+config.date_range = true
+```
+
+Then run:
+
+    $ rails generate dog_biscuits:dates
+
+### Date picker in edit form
+
+Control date fields with a date picker by setting the following flag in `config/initializers/dog_biscuits.rb`:
+
+```
+config.date_picker = true
+```
+
+Change which fields are controlled by the picker by changing `config.date_properties` in `config/initializers/dog_biscuits.rb`. The default is all date fields.
+ 
+Then run:
+
+    $ rails generate dog_biscuits:dates
+
+## Documentation
+
+Further documentation is available in the [wiki](https://github.com/samvera-labs/dog_biscuits/wiki).

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'solr_wrapper'   # necessary for rake_support to work
+require 'fcrepo_wrapper' # necessary for rake_support to work
+require 'engine_cart/rake_task'
+require 'rubocop/rake_task'
+require 'active_fedora/rake_support'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Spin up test servers and run specs'
+task :spec_with_app_load do
+  with_test_server do
+    Rake::Task['spec'].invoke
+  end
+end
+
+desc 'Generate the engine_cart, spin up test servers and run specs'
+task ci: ['rubocop', 'engine_cart:generate'] do
+  puts 'running continuous integration'
+  Rake::Task['spec_with_app_load'].invoke
+end
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+task default: :ci

data/SUPPORT.md

@@ -0,0 +1,5 @@
+If you would like to report an issue, first search [the list of issues](https://github.com/samvera/questioning_authority/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera/questioning_authority/issues/new).
+
+If you have questions or need help, please email [the Samvera community tech list](https://groups.google.com/forum/#!forum/samvera-tech) or stop by the #dev channel in [the Samvera community Slack team](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391#Getintouch!-Slack).
+
+You can learn more about the various Samvera communication channels on the [Get in touch!](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391) wiki page.

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dog_biscuits'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dog_biscuits.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'dog_biscuits/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dog_biscuits'
+  spec.version       = DogBiscuits::VERSION
+  spec.authors       = ['Julie Allinson']
+  spec.email         = ['julie.allinson@london.ac.uk']
+
+  spec.summary       = 'DogBiscuits provides re-usable models, vocabularies and other services for Hyrax applications.'
+  spec.description   = 'DogBiscuits provides re-usable models, vocabularies and other services for Hyrax applications.'
+  spec.homepage      = 'https://github.com/samvera-labs/dog_biscuits'
+  spec.license       = 'APACHE2'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hyrax', '>= 2', '< 3'
+
+  spec.add_development_dependency 'bixby'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'engine_cart'
+  spec.add_development_dependency 'factory_bot_rails', '~> 4.11'
+  spec.add_development_dependency 'fcrepo_wrapper'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'solr_wrapper'
+  spec.add_development_dependency 'webmock'
+end

data/lib/dog_biscuits.rb

@@ -0,0 +1,352 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  extend ActiveSupport::Autoload
+  require 'dog_biscuits/railtie' if defined?(Rails)
+
+  eager_autoload do
+    autoload :Configuration
+  end
+
+  module Actors
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :ApplyAuthorities
+      autoload :SingularAttributes
+    end
+  end
+
+  module Blacklight
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :Commands
+    end
+  end
+
+  module Importers
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :Authority
+    end
+  end
+
+  module Solr
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :IndexTypes
+    end
+  end
+
+  module Vocab
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :Generic
+      autoload :BorthwickRegisters
+      autoload :OaisArchivematica
+      autoload :PureTerms
+      autoload :Uketd
+      autoload :LocalResourceTerms
+      autoload :UlccTerms
+    end
+  end
+
+  autoload_under 'property_mappings' do
+    autoload :PropertyMappings
+  end
+
+  autoload_under 'services' do
+    autoload :Terms
+    autoload :TermsService
+    autoload :TableBasedAuthorityExtended
+  end
+
+  autoload_under 'models' do
+    autoload :Work
+    autoload :Authority
+  end
+
+  autoload_under 'models/authorities' do
+    autoload :Concept
+    autoload :ConceptScheme
+    autoload :Event
+    autoload :Place
+    autoload :Agent
+    autoload :Project
+  end
+  autoload_under 'models/authorities/agents' do
+    autoload :Group
+    autoload :HistoricPerson
+    autoload :Organisation
+    autoload :Person
+  end
+
+  autoload_under 'models/collections' do
+    autoload :Collection
+  end
+  autoload_under 'models/filesets' do
+    autoload :FileSet
+  end
+  autoload_under 'models/works' do
+    autoload :ConferenceItem
+    autoload :Dataset
+    autoload :DigitalArchivalObject
+    autoload :ExamPaper
+    autoload :JournalArticle
+    autoload :Package
+    autoload :PublishedWork
+    autoload :Thesis
+  end
+
+  autoload_under 'models/concerns' do
+    autoload :ExtendedSolrDocument
+  end
+
+  autoload_under 'models/concerns/model_property_sets' do
+    autoload :AgentMetadata
+    autoload :ConferenceItemMetadata
+    autoload :DatasetMetadata
+    autoload :DigitalArchivalObjectMetadata
+    autoload :ExamPaperMetadata
+    autoload :JournalArticleMetadata
+    autoload :PackageMetadata
+    autoload :PublishedWorkMetadata
+    autoload :ThesisMetadata
+  end
+
+  autoload_under 'models/concerns/model_property_sets/common' do
+    autoload :CommonLabels
+    autoload :CommonMetadata
+    autoload :CommonRights
+  end
+
+  autoload_under 'models/concerns/metadata_properties/archivematica' do
+    autoload :Archivematica
+  end
+
+  autoload_under 'models/concerns/metadata_properties/archives_hub' do
+    autoload :AccessProvidedBy
+    autoload :MaintenanceAgencyCode
+    autoload :HubDates
+  end
+
+  autoload_under 'models/concerns/metadata_properties/bibframe' do
+    autoload :AwardingInstitution
+    autoload :DateValid
+    autoload :Edition
+    autoload :IdentifiedBy
+    autoload :InJournal
+    autoload :OriginDate
+    autoload :Part
+    autoload :PartOf
+    autoload :Series
+    autoload :Subtitle
+  end
+
+  autoload_under 'models/concerns/metadata_properties/bibo' do
+    autoload :PresentedAt
+    autoload :PublicationStatus
+  end
+
+  autoload_under 'models/concerns/metadata_properties/datacite' do
+    autoload :ResourceTypeGeneral
+  end
+
+  autoload_under 'models/concerns/metadata_properties/dc' do
+    autoload :Abstract
+    autoload :AccessRights
+    autoload :BibliographicCitation
+    autoload :Creator
+    autoload :Contributor
+    autoload :Date
+    autoload :DateAccepted
+    autoload :DateAvailable
+    autoload :DateCopyrighted
+    autoload :DateCreated
+    autoload :DateIssued
+    autoload :Description
+    autoload :Extent
+    autoload :Format
+    autoload :Identifier
+    autoload :Language
+    autoload :Publisher
+    autoload :ResourceType
+    autoload :Rights
+    autoload :RightsHolder
+    autoload :Source
+    autoload :Subject
+    # autoload :Title # part of CoreMetadata
+    autoload :SimpleVersions
+  end
+
+  autoload_under 'models/concerns/metadata_properties/dwc' do
+    autoload :EventDate
+  end
+
+  autoload_under 'models/concerns/metadata_properties/local' do
+    autoload :ForIndexing
+    autoload :FormerIdentifier
+    autoload :GenericAuthorityTerms
+    autoload :ModuleCode
+    autoload :GenericQualifier
+    autoload :LastAccess
+    autoload :MainFile
+    autoload :NumberOfDownloads
+    autoload :PackagedBy
+    autoload :ReadmeFile
+    autoload :RequestorEmail
+  end
+
+  autoload_under 'models/concerns/metadata_properties/edm' do
+    autoload :EdmRights
+  end
+
+  autoload_under 'models/concerns/metadata_properties/fabio' do
+    autoload :DateCollected
+  end
+
+  autoload_under 'models/concerns/metadata_properties/foaf' do
+    autoload :BasedNear
+    autoload :FoafName
+  end
+
+  autoload_under 'models/concerns/metadata_properties/frapo' do
+    autoload :OutputOf
+  end
+
+  autoload_under 'models/concerns/metadata_properties/geo' do
+    autoload :Geo
+  end
+
+  autoload_under 'models/concerns/metadata_properties/geonames' do
+    autoload :CountryCode
+    autoload :PlaceProperties
+  end
+
+  autoload_under 'models/concerns/metadata_properties/lc_identifiers' do
+    autoload :Doi
+    autoload :Isbn
+    autoload :OfficialUrl
+    autoload :Orcid
+  end
+
+  autoload_under 'models/concerns/metadata_properties/mads' do
+    autoload :RelatedAuthority
+  end
+
+  autoload_under 'models/concerns/metadata_properties/mods' do
+    autoload :DateValid
+  end
+
+  autoload_under 'models/concerns/metadata_properties/marc_relators' do
+    autoload :Advisor
+    autoload :Funder
+    autoload :Editor
+    autoload :PlaceOfPublication
+  end
+
+  autoload_under 'models/concerns/metadata_properties/owl' do
+    autoload :OwlSameAs
+  end
+
+  autoload_under 'models/concerns/metadata_properties/premis' do
+    autoload :HasRestriction
+  end
+
+  autoload_under 'models/concerns/metadata_properties/property_sets' do
+    autoload :PersonProperties
+  end
+
+  autoload_under 'models/concerns/metadata_properties/pure' do
+    autoload :Pure
+    autoload :ManagingOrganisation
+  end
+
+  autoload_under 'models/concerns/metadata_properties/rdf' do
+    autoload :RdfType
+    autoload :RelatedUrl
+    autoload :RdfsLabel
+  end
+
+  autoload_under 'models/concerns/metadata_properties/schema' do
+    autoload :ContentVersion
+    autoload :DateUpdated
+    autoload :DatePublished
+    autoload :Department
+    autoload :EndDate
+    autoload :IssueNumber
+    autoload :Location
+    autoload :Keyword
+    autoload :Pagination
+    autoload :StartDate
+    autoload :VolumeNumber
+    autoload :AlternateName
+  end
+
+  autoload_under 'models/concerns/metadata_properties/skos' do
+    autoload :SkosLabels
+    autoload :SkosNote
+    autoload :SkosRelated
+  end
+
+  autoload_under 'models/concerns/metadata_properties/vivo' do
+  end
+
+  autoload_under 'models/concerns/metadata_properties/uketd' do
+    autoload :DateOfAward
+    autoload :Qualification
+  end
+
+  autoload_under 'models/concerns/metadata_properties/ulcc' do
+    autoload :DateSubmitted
+    autoload :Refereed
+  end
+
+  autoload_under 'models/concerns/behaviours' do
+    # Behaviour
+    autoload :WorkBehaviour
+    autoload :PureSpecificBehaviour
+    # Validations
+    autoload :ValidateConceptScheme
+    autoload :ValidateConceptRelated
+    autoload :ValidateLabel
+    autoload :ValidatePlace
+  end
+
+  autoload_under 'indexers' do
+    # Indexer classes
+    autoload :ConferenceItemIndexer
+    autoload :DatasetIndexer
+    autoload :DigitalArchivalObjectIndexer
+    autoload :ExamPaperIndexer
+    autoload :JournalArticleIndexer
+    autoload :PackageIndexer
+    autoload :PublishedWorkIndexer
+    autoload :ThesisIndexer
+  end
+  autoload_under 'indexers/concerns' do
+    # Indexer modules
+    autoload :IndexesCommon
+  end
+
+  autoload_under 'validators' do
+    autoload :LabelValidator
+    autoload :PlaceValidator
+    autoload :ConceptSchemeMemberValidator
+    autoload :ConceptRelatedValidator
+  end
+
+  # @api public
+  #
+  # Exposes the DogBiscuits configuration
+  #
+  # @yield [DogBiscuits::Configuration] if a block is passed
+  # @return [DogBiscuits::Configuration]
+  # @see DogBiscuits::Configuration for configuration options
+  def self.config(&block)
+    @config ||= DogBiscuits::Configuration.new
+
+    yield @config if block
+
+    @config
+  end
+end