hyrax-doi 0.1.0

data/app/views/hyrax/base/_attribute_rows.html.erb

@@ -0,0 +1,18 @@
+<%# Overridden to display doi attribute (Copied here from Hyrax 2.9) %>
+<%# _attribute_rows.html.erb is likely to be overridden per work type so this provides a %>
+<%# simple out of the box way to show the doi while not impedeing those who choose to customize %>
+<%= presenter.attribute_to_html(:date_modified, label: t('hyrax.base.show.last_modified'), html_dl: true) %>
+<%= presenter.attribute_to_html(:creator, render_as: :faceted, html_dl: true) %>
+<%= presenter.attribute_to_html(:contributor, render_as: :faceted, html_dl: true) %>
+<%= presenter.attribute_to_html(:subject, render_as: :faceted, html_dl: true) %>
+<%= presenter.attribute_to_html(:publisher, render_as: :faceted, html_dl: true) %>
+<%= presenter.attribute_to_html(:language, render_as: :faceted, html_dl: true) %>
+<%= presenter.attribute_to_html(:identifier, render_as: :linked, search_field: 'identifier_tesim', html_dl: true) %>
+<%= presenter.attribute_to_html(:keyword, render_as: :faceted, html_dl: true) %>
+<%= presenter.attribute_to_html(:date_created, render_as: :linked, search_field: 'date_created_tesim', html_dl: true) %>
+<%= presenter.attribute_to_html(:based_near_label, html_dl: true) %>
+<%= presenter.attribute_to_html(:related_url, render_as: :external_link, html_dl: true) %>
+<%= presenter.attribute_to_html(:resource_type, render_as: :faceted, html_dl: true) %>
+<%= presenter.attribute_to_html(:source, html_dl: true) %>
+<%= presenter.attribute_to_html(:rights_statement, render_as: :rights_statement, html_dl: true) %>
+<%= presenter.attribute_to_html(:doi, render_as: :external_link, html_dl: true) if respond_to?(:render_doi?) && render_doi?(presenter) %>

data/app/views/hyrax/base/_form_doi.html.erb

@@ -0,0 +1,73 @@
+<div>
+  <%# TODO: Make this appear as singular %>
+  <%= render_edit_field_partial('doi', f: f) %>
+
+  <%= link_to "Create draft DOI",
+              Hyrax::DOI::Engine.routes.url_helpers.create_draft_doi_path,
+              remote: true,
+              method: :get,
+              data: {
+                disable_with: "Creating draft DOI...",
+                params: {
+                  curation_concern: curation_concern.class.name.underscore,
+                  attribute: 'doi'
+                }
+              },
+              class: 'btn btn-default',
+              id: 'doi-create-draft-btn' %>
+
+  <%= link_to "Autofill form",
+              Hyrax::DOI::Engine.routes.url_helpers.autofill_path,
+              remote: true,
+              method: :get,
+              data: {
+                confirm: "This operation is destructive and will replace any information already filled in on this form.",
+                disable_with: "Autofilling form...",
+                params: { curation_concern: curation_concern.class.name.underscore }
+              },
+              class: 'btn btn-primary',
+              id: 'doi-autofill-btn' %>
+
+  <br/><br/><br/>
+
+  <fieldset class="set-doi-status-when-public">
+    <label class="control-label">DOI status when work is public</label>
+
+    <div class="form-group" style="margin-left: 20px">
+      <label class="radio" style="font-weight: normal">
+        <%= f.radio_button :doi_status_when_public, '', style: 'margin-top: 0px;' %>
+        Do not mint
+      </label>
+      <label class="radio" style="font-weight: normal">
+        <%= f.radio_button :doi_status_when_public, 'draft', style: 'margin-top: 0px;' %>
+        Draft
+      </label>
+      <label class="radio" style="font-weight: normal">
+        <%= f.radio_button :doi_status_when_public, 'registered', style: 'margin-top: 0px;' %>
+        Registered
+      </label>
+      <label class="radio" style="font-weight: normal">
+        <%= f.radio_button :doi_status_when_public, 'findable', style: 'margin-top: 0px;' %>
+        Findable
+      </label>
+    </div>
+  </fieldset>
+</div>
+
+<script type="text/javascript">
+  // Append the DOI filled in the form to the request
+  // Note this uses jQuery since we're using jquery-ujs still
+  // There is probably a better way to do this but this works for now
+  $("#doi-autofill-btn").on("ajax:beforeSend", function(e, xhr, settings) {
+    doi = $('#generic_work_doi').val()
+    settings.url = settings.url + "&doi=" + encodeURIComponent(doi)
+  });
+
+  $("#doi-create-draft-btn").on("ajax:error", function(e, xhr, status, error) {
+    alert(xhr.responseText);
+  });
+
+  $("#doi-autofill-btn").on("ajax:error", function(e, xhr, status, error) {
+    alert(xhr.responseText);
+  });
+</script>

data/config/locales/hyrax_doi.en.yml

@@ -0,0 +1,7 @@
+---
+en:
+  hyrax:
+    works:
+      form:
+        tab:
+          doi: DOI

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+Hyrax::DOI::Engine.routes.draw do
+  get '/create_draft_doi', controller: 'hyrax_doi', action: 'create_draft_doi', as: 'create_draft_doi'
+  get '/autofill', controller: 'hyrax_doi', action: 'autofill', as: 'autofill'
+end

data/lib/generators/hyrax/doi/add_to_work_type_generator.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+require 'rails/generators'
+require 'rails/generators/model_helpers'
+
+module Hyrax
+  module DOI
+    class AddToWorkTypeGenerator < Rails::Generators::NamedBase
+      # ActiveSupport can interpret models as plural which causes
+      # counter-intuitive route paths. Pull in ModelHelpers from
+      # Rails which warns users about pluralization when generating
+      # new models or scaffolds.
+      include Rails::Generators::ModelHelpers
+
+      # Required due to non-standard capitalization of DOI namespace
+      namespace 'hyrax:doi:add_to_work_type'
+      # Same as adding --skip-namespace flag to generator call
+      # This removes the hyrax/doi namespace from class_path
+      # Namespaces passed as the argument will still appear in class_path
+      class_option :skip_namespace, default: true
+
+      # DataCite-specific support
+      class_option :datacite, type: :boolean, default: false, desc: "Add DataCite-specific behavior."
+
+      desc "Add DOI support to given work type"
+      def inject_into_model
+        # rubocop:disable Style/RedundantSelf
+        # For some reason I had to use self.destination_root here to get all contexts to work (calling from hyrax app, calling from this engine to test app, rspec tests)
+        self.destination_root = Rails.root if self.destination_root.blank? || self.destination_root == Hyrax::DOI::Engine.root.to_s
+        model_file = File.join(self.destination_root, 'app', 'models', *class_path, "#{file_name}.rb")
+        # rubocop:enable Style/RedundantSelf
+
+        insert_into_file model_file, after: 'include ::Hyrax::WorkBehavior' do
+          "\n" \
+          "  # Adds behaviors for hyrax-doi plugin.\n" \
+          "  include Hyrax::DOI::DOIBehavior"
+        end
+
+        return unless options[:datacite]
+
+        # DataCite specific behavior
+        insert_into_file model_file, after: 'include Hyrax::DOI::DOIBehavior' do
+          "\n" \
+          "  # Adds behaviors for DataCite DOIs via hyrax-doi plugin.\n" \
+          "  include Hyrax::DOI::DataCiteDOIBehavior"
+        end
+      end
+
+      desc "Add DOI support to given work type form"
+      def inject_into_form
+        # rubocop:disable Style/RedundantSelf
+        # For some reason I had to use self.destination_root here to get all contexts to work (calling from hyrax app, calling from this engine to test app, rspec tests)
+        self.destination_root = Rails.root if self.destination_root.blank? || self.destination_root == Hyrax::DOI::Engine.root.to_s
+        form_file = File.join(self.destination_root, 'app', 'forms', 'hyrax', *class_path, "#{file_name}_form.rb")
+        # rubocop:enable Style/RedundantSelf
+
+        insert_into_file form_file, after: 'Hyrax::Forms::WorkForm' do
+          "\n" \
+          "    # Adds behaviors for hyrax-doi plugin.\n" \
+          "    include Hyrax::DOI::DOIFormBehavior"
+        end
+
+        return unless options[:datacite]
+
+        # DataCite specific behavior
+        insert_into_file form_file, after: 'include Hyrax::DOI::DOIFormBehavior' do
+          "\n" \
+          "    # Adds behaviors for DataCite DOIs via hyrax-doi plugin.\n" \
+          "    include Hyrax::DOI::DataCiteDOIFormBehavior"
+        end
+      end
+
+      desc "Add DOI support to given work type presenter"
+      def inject_into_presenter
+        # rubocop:disable Style/RedundantSelf
+        # For some reason I had to use self.destination_root here to get all contexts to work (calling from hyrax app, calling from this engine to test app, rspec tests)
+        self.destination_root = Rails.root if self.destination_root.blank? || self.destination_root == Hyrax::DOI::Engine.root.to_s
+        presenter_file = File.join(self.destination_root, 'app', 'presenters', 'hyrax', *class_path, "#{file_name}_presenter.rb")
+        # rubocop:enable Style/RedundantSelf
+
+        insert_into_file presenter_file, after: '::WorkShowPresenter' do
+          "\n" \
+          "    # Adds behaviors for hyrax-doi plugin.\n" \
+          "    include Hyrax::DOI::DOIPresenterBehavior"
+        end
+
+        return unless options[:datacite]
+
+        # DataCite specific behavior
+        insert_into_file presenter_file, after: 'include Hyrax::DOI::DOIPresenterBehavior' do
+          "\n" \
+          "    # Adds behaviors for DataCite DOIs via hyrax-doi plugin.\n" \
+          "    include Hyrax::DOI::DataCiteDOIPresenterBehavior"
+        end
+      end
+    end
+  end
+end

data/lib/generators/hyrax/doi/install_generator.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+require 'rails/generators'
+require 'rails/generators/model_helpers'
+
+module Hyrax
+  module DOI
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Required due to non-standard capitalization of DOI namespace
+      namespace 'hyrax:doi:install'
+      # Same as adding --skip-namespace flag to generator call
+      # This removes the hyrax/doi namespace from class_path
+      # Namespaces passed as the argument will still appear in class_path
+      class_option :skip_namespace, default: true
+
+      # DataCite-specific support
+      class_option :datacite, type: :boolean, default: false, desc: "Add DataCite-specific behavior."
+
+      def generate_config
+        # rubocop:disable Style/RedundantSelf
+        # For some reason I had to use self.destination_root here to get all contexts to work (calling from hyrax app, calling from this engine to test app, rspec tests)
+        self.destination_root = Rails.root if self.destination_root.blank? || self.destination_root == Hyrax::DOI::Engine.root.to_s
+        initializer_file = File.join(self.destination_root, 'config', 'initializers', 'hyrax-doi.rb')
+        # rubocop:enable Style/RedundantSelf
+
+        copy_file "config/initializers/hyrax-doi.rb", initializer_file
+      end
+
+      def inject_into_helper
+        # rubocop:disable Style/RedundantSelf
+        # For some reason I had to use self.destination_root here to get all contexts to work (calling from hyrax app, calling from this engine to test app, rspec tests)
+        self.destination_root = Rails.root if self.destination_root.blank? || self.destination_root == Hyrax::DOI::Engine.root.to_s
+        helper_file = File.join(self.destination_root, 'app', 'helpers', "hyrax_helper.rb")
+        # rubocop:enable Style/RedundantSelf
+
+        insert_into_file helper_file, after: 'include Hyrax::HyraxHelperBehavior' do
+          "\n" \
+          "  # Helpers provided by hyrax-doi plugin.\n" \
+          "  include Hyrax::DOI::HelperBehavior"
+        end
+      end
+
+      def inject_into_solr_document
+        # rubocop:disable Style/RedundantSelf
+        # For some reason I had to use self.destination_root here to get all contexts to work (calling from hyrax app, calling from this engine to test app, rspec tests)
+        self.destination_root = Rails.root if self.destination_root.blank? || self.destination_root == Hyrax::DOI::Engine.root.to_s
+        solr_document_file = File.join(self.destination_root, 'app', 'models', "solr_document.rb")
+        # rubocop:enable Style/RedundantSelf
+
+        insert_into_file solr_document_file, after: 'include Hyrax::SolrDocumentBehavior' do
+          "\n" \
+          "  # Add attributes for DOIs for hyrax-doi plugin.\n" \
+          "  include Hyrax::DOI::SolrDocument::DOIBehavior"
+        end
+
+        return unless options[:datacite]
+
+        # DataCite specific behavior
+        insert_into_file solr_document_file, after: 'Hyrax::DOI::SolrDocument::DOIBehavior' do
+          "\n" \
+          "  # Add attributes for DataCite DOIs for hyrax-doi plugin.\n" \
+          "  include Hyrax::DOI::SolrDocument::DataCiteDOIBehavior"
+        end
+      end
+
+      def mount_engine_routes
+        inject_into_file 'config/routes.rb', after: /mount Hyrax::Engine, at: '\S*'\n/ do
+          "  mount Hyrax::DOI::Engine, at: '/doi', as: 'hyrax_doi'\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/hyrax/doi/templates/config/initializers/hyrax-doi.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+## Set a default host for urls generated by the DOI registrars (if necessary)
+# Rails.application.routes.default_url_options[:host] = 'localhost:3000'
+
+## Remote identifiers configuration
+# Add registrar implementations by uncommenting and adding to the hash below.
+# See app/services/hyrax/identifier/registrar.rb for the registrar interface
+Hyrax.config.identifier_registrars = { datacite: Hyrax::DOI::DataCiteRegistrar }
+
+## For DataCite DOIs
+# Test mode will use the DataCite test environment
+Hyrax::DOI::DataCiteRegistrar.mode = :test # Possible options are [:production, :test]
+Hyrax::DOI::DataCiteRegistrar.prefix = ENV['DATACITE_PREFIX']
+Hyrax::DOI::DataCiteRegistrar.username = ENV['DATACITE_USERNAME']
+Hyrax::DOI::DataCiteRegistrar.password = ENV['DATACITE_PASSWORD']

data/lib/hyrax/doi.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require "hyrax/doi/engine"
+require "hyrax/doi/errors"
+
+module Hyrax
+  module DOI
+    # Your code goes here...
+  end
+end

data/lib/hyrax/doi/engine.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    class Engine < ::Rails::Engine
+      isolate_namespace Hyrax::DOI
+
+      config.before_configuration do
+        # Fix camelizing of paths for autoloading
+        # With this hyrax/doi/application_helper -> Hyrax::DOI::ApplicationHelper
+        ActiveSupport::Inflector.inflections(:en) do |inflect|
+          inflect.acronym 'DOI'
+          inflect.acronym 'DataCite'
+        end
+      end
+
+      config.after_initialize do
+        Hyrax::CurationConcern.actor_factory.use Hyrax::Actors::DOIActor
+
+        require 'bolognese'
+        Bolognese::Metadata.prepend Bolognese::Readers::HyraxWorkReader
+        Bolognese::Metadata.prepend Bolognese::Writers::HyraxWorkWriter
+
+        # Prepend our views so they have precedence
+        ActionController::Base.prepend_view_path(paths['app/views'].existent)
+      end
+    end
+  end
+end

data/lib/hyrax/doi/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module DOI
+    class Error < ::StandardError; end
+    class NotFoundError < Hyrax::DOI::Error; end
+  end
+end

data/lib/hyrax/doi/spec/shared_specs.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'hyrax/doi/spec/shared_specs/datacite_doi_behavior'
+require 'hyrax/doi/spec/shared_specs/datacite_doi_form_behavior'
+require 'hyrax/doi/spec/shared_specs/datacite_doi_presenter_behavior'
+require 'hyrax/doi/spec/shared_specs/doi_behavior'
+require 'hyrax/doi/spec/shared_specs/doi_form_behavior'
+require 'hyrax/doi/spec/shared_specs/doi_presenter_behavior'
+require 'hyrax/doi/spec/shared_specs/solr_document/datacite_doi_behavior'
+require 'hyrax/doi/spec/shared_specs/solr_document/doi_behavior'

data/lib/hyrax/doi/spec/shared_specs/datacite_doi_behavior.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+RSpec.shared_examples "a DataCite DOI-enabled model" do
+  subject { work }
+
+  let(:properties) do
+    [:doi_status_when_public]
+  end
+
+  describe "properties" do
+    it "has DataCite DOI properties" do
+      properties.each do |property|
+        expect(subject).to respond_to(property)
+      end
+    end
+  end
+
+  describe 'validations' do
+    it 'validates inclusion of doi_status_when_public' do
+      expect(subject).to validate_inclusion_of(:doi_status_when_public).in_array([nil] + Hyrax::DOI::DataCiteRegistrar::STATES).allow_nil
+    end
+  end
+
+  describe 'to_solr' do
+    let(:solr_doc) { subject.to_solr }
+
+    let(:solr_fields) do
+      [:doi_status_when_public_ssi]
+    end
+
+    before do
+      work.doi_status_when_public = 'draft'
+    end
+
+    it 'has solr fields' do
+      solr_fields.each do |field|
+        expect(solr_doc.fetch(field.to_s)).not_to be_blank
+      end
+    end
+  end
+end

data/lib/hyrax/doi/spec/shared_specs/datacite_doi_form_behavior.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+RSpec.shared_examples "a DataCite DOI-enabled form" do
+  subject { form }
+
+  describe "properties" do
+    it { is_expected.to delegate_method(:doi_status_when_public).to(:model) }
+
+    it 'includes properties in the list of terms' do
+      expect(subject.terms).to include(:doi_status_when_public)
+    end
+
+    it 'does not include properties in primary or secondary' do
+      expect(subject.primary_terms).not_to include(:doi_status_when_public)
+      expect(subject.secondary_terms).not_to include(:doi_status_when_public)
+    end
+  end
+end

data/lib/hyrax/doi/spec/shared_specs/datacite_doi_presenter_behavior.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+RSpec.shared_examples "a DataCite DOI-enabled presenter" do
+  subject { presenter }
+
+  let(:presenter) { presenter_class.new(solr_document, nil, nil) }
+  let(:solr_document) { instance_double(solr_document_class) }
+
+  it { is_expected.to delegate_method(:doi_status_when_public).to(:solr_document) }
+
+  describe 'doi_status' do
+    before do
+      allow(solr_document).to receive(:doi_status_when_public).and_return(doi_status_when_public)
+    end
+
+    let(:doi_status_when_public) { 'draft' }
+
+    context 'when findable' do
+      let(:doi_status_when_public) { 'findable' }
+
+      context 'when public' do
+        it 'is findable' do
+          allow(solr_document).to receive(:public?).and_return(true)
+          expect(subject.doi_status).to eq 'findable'
+        end
+      end
+
+      context 'when not public' do
+        it 'is registered' do
+          allow(solr_document).to receive(:public?).and_return(false)
+          expect(subject.doi_status).to eq 'registered'
+        end
+      end
+    end
+
+    it 'returns the status' do
+      expect(subject.doi_status).to eq doi_status_when_public
+    end
+  end
+end