hyrax 3.0.0.pre.rc2 → 3.0.0.pre.rc3

data/lib/hyrax/event_store.rb

@@ -3,6 +3,7 @@
 module Hyrax
   ##
   # @abstract
+  #
   # The event store provides an interface to log numbered events into a storage
   # system, e.g. a key-value store.
   #
@@ -21,6 +22,10 @@ module Hyrax
   # @see Hyrax::Event
   class EventStore
     class << self
+      ##
+      # @!method logger
+      #   @return [Logger]
+      #   @see Hyrax.logger
       delegate :logger, to: Hyrax
 
       ##

data/lib/hyrax/form_fields.rb

@@ -14,7 +14,7 @@ module Hyrax
   ##
   # @api private
   #
-  # @see Hyrax.FormFields
+  # @see .FormFields
   class FormFields < Module
     attr_reader :name
 

data/lib/hyrax/indexer.rb

@@ -2,7 +2,21 @@
 
 module Hyrax
   ##
-  # @public
+  # @api public
+  #
+  # Build an indexer module from a schema. Generates custom indexer behavior
+  # from rules provided by `index_loader`.
+  #
+  # @param [Symbol] schema_name
+  # @param [#index_rule_for] index_loader
+  #
+  # @return [Module]
+  #
+  # @example building a module as a mixin
+  #
+  #   class MyIndexer < Hyrax::ValkyrieIndexer
+  #     include Hyrax::Indexer(:core_metadata)
+  #   end
   #
   # @since 3.0.0
   def self.Indexer(schema_name, index_loader: SimpleSchemaLoader.new)
@@ -10,10 +24,12 @@ module Hyrax
   end
 
   ##
-  # @private
+  # @api private
+  #
+  # @see .Indexer
   class Indexer < Module
     ##
-    # @param [Symbol] schema
+    # @param [Hash{Symbol => Symbol}] rules
     def initialize(rules)
       define_method :to_solr do |*args|
         super(*args).tap do |document|

data/lib/hyrax/publisher.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 
 module Hyrax
@@ -9,7 +10,7 @@ module Hyrax
   # reflect the kinds of resources the event applied to.
   #
   #   - `batch`: events related to the performance of `BatchCreateJob`
-  #   - `file_set`: events related to the lifecycle of Hydra Works FileSets
+  #   - `file.set`: events related to the lifecycle of Hydra Works FileSets
   #   - `object`: events related to the lifecycle of all PCDM Objects
   #
   # Applications *SHOULD* publish events whenever the relevant actions are
@@ -37,28 +38,96 @@ module Hyrax
   # @example use Hyrax.publisher
   #   Hyrax.publisher.publish('object.deposited', object: deposited_object, user: depositing_user)
   #
+  # Below is an example of subscribing using an anonymous block.  A
+  # potential disadvantage of an anonymous block is that you cannot
+  # easily unsubscribe to that block.
+  #
   # @example subscribing to an event type/stream with a block handler
   #   publisher = Hyrax::Publisher.instance
   #
-  #   publisher.subscribe('object.deposited') do |event |
+  #   publisher.subscribe('object.deposited') do |event|
   #     do_something(event[:object])
   #   end
   #
+  # Below is an example of subscribing using an object.  A potential
+  # advantage of subscribing with an object is that you can later
+  # unsubscribe the object.
+  #
+  # @example subscribing to an event type/stream with an event listener.
+  #
+  #   class EventListener
+  #     # @param event [#[]] The given event[:object] should be the deposited object.
+  #     def on_object_deposited(event)
+  #       do_something(event[:object])
+  #     end
+  #   end
+  #   event_listener = EventListener.new
+  #
+  #   publisher = Hyrax::Publisher.instance
+  #
+  #   publisher.subscribe(event_listener)
+  #
+  #   # The above subscribed event_listener instance will receive an #on_object_deposited message
+  #   # with an event that has two keys: `:object` and `:user`
+  #   publisher.publish('object.deposited', object: deposited_object, user: depositing_user)
+  #
+  #   publisher.unsubscribe(event_listener)
+  #
   # @see https://dry-rb.org/gems/dry-events/0.2/
   # @see Dry::Events::Publisher
+  # @see https://github.com/samvera/hyrax/wiki/Hyrax's-Event-Bus-(Hyrax::Publisher)
   class Publisher
     include Singleton
     include Dry::Events::Publisher[:hyrax]
 
+    # @!group Registered Events
+    #
+    # 🛑 👀 ❓
+    # are you adding an event?
+    # make sure Hyrax is publishing events in the correct places (this is be non-trivial!)
+    # and add it to the list at https://github.com/samvera/hyrax/wiki/Hyrax's-Event-Bus-(Hyrax::Publisher)
+
+    # @!macro [new] a_registered_event
+    #   @!attribute [r] $1
+
+    # @since 3.0.0
+    # @macro a_registered_event
     register_event('batch.created')
+
+    # @since 3.0.0
+    # @macro a_registered_event
     register_event('file.set.audited')
+
+    # @since 3.0.0
+    # @macro a_registered_event
     register_event('file.set.attached')
+
+    # @since 3.0.0
+    # @macro a_registered_event
     register_event('file.set.url.imported')
+
+    # @since 3.0.0
+    # @macro a_registered_event
     register_event('file.set.restored')
+
+    # @since 3.0.0
+    # @macro a_registered_event
     register_event('object.deleted')
+
+    # @since 3.0.0
+    # @macro a_registered_event
     register_event('object.failed_deposit')
+
+    # @since 3.0.0
+    # @macro a_registered_event
     register_event('object.deposited')
+
+    # @since 3.0.0
+    # @macro a_registered_event
     register_event('object.acl.updated')
+
+    # @since 3.0.0
+    # @macro a_registered_event
     register_event('object.metadata.updated')
   end
 end

data/lib/hyrax/resource_sync/change_list_writer.rb

@@ -95,7 +95,7 @@ module Hyrax
       delegate :collection_url, to: :routes
 
       def public_access
-        { Hydra.config.permissions.read.group => 'public' }
+        { Hydra.config.permissions.read.group => Hyrax.config.public_user_group_name }
       end
     end
   end

data/lib/hyrax/resource_sync/resource_list_writer.rb

@@ -78,7 +78,7 @@ module Hyrax
       delegate :collection_url, to: :routes
 
       def public_access
-        { Hydra.config.permissions.read.group => 'public' }
+        { Hydra.config.permissions.read.group => Hyrax.config.public_user_group_name }
       end
     end
   end

data/lib/hyrax/schema.rb

@@ -10,7 +10,7 @@ module Hyrax
   # `Dry::Type` types.
   #
   # For the default schema loader, configuration is loaded from
-  # `config/metadata/{name}.yaml`. Custom schema loaders can be provided
+  # `config/metadata/[name]}.yaml`. Custom schema loaders can be provided
   # for other types.
   #
   # @note `Valkyrie::Resources`/`Hyrax::Resources` are not required to use this
@@ -48,7 +48,7 @@ module Hyrax
   # applied to a `Valkyrie::Resource`. This provides the internals for the
   # recommended module builder syntax: `Hyrax::Schema(:schema_name)`
   #
-  # @see Hyrax.Schema
+  # @see .Schema
   class Schema < Module
     ##
     # @!attribute [r] name

data/lib/hyrax/specs/capybara.rb

@@ -0,0 +1,98 @@
+# without lines 1-12, screenshots and html captured from failing specs are blank
+# source: https://github.com/mattheworiordan/capybara-screenshot/issues/225
+require "action_dispatch/system_testing/test_helpers/setup_and_teardown"
+::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.module_eval do
+  def before_setup
+    super
+  end
+
+  def after_teardown
+    super
+  end
+end
+
+require 'capybara/rspec'
+require 'capybara/rails'
+require 'capybara-screenshot/rspec'
+require 'selenium-webdriver'
+require 'webdrivers'
+
+if ENV['IN_DOCKER'].present?
+  args = %w[disable-gpu no-sandbox whitelisted-ips window-size=1400,1400]
+  args.push('headless') if ActiveModel::Type::Boolean.new.cast(ENV['CHROME_HEADLESS_MODE'])
+
+  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(chromeOptions: { args: args })
+
+  Capybara.register_driver :selenium_chrome_headless_sandboxless do |app|
+    driver = Capybara::Selenium::Driver.new(app,
+                                       browser: :remote,
+                                       desired_capabilities: capabilities,
+                                       url: ENV['HUB_URL'])
+
+    # Fix for capybara vs remote files. Selenium handles this for us
+    driver.browser.file_detector = lambda do |args|
+      str = args.first.to_s
+      str if File.exist?(str)
+    end
+
+    driver
+  end
+
+  Capybara.server_host = '0.0.0.0'
+  Capybara.server_port = 3010
+  Capybara.app_host = ENV['CAPYBARA_SERVER'] || 'http://127.0.0.1:3010'
+else
+  TEST_HOST = 'localhost:3000'.freeze
+  # @note In January 2018, TravisCI disabled Chrome sandboxing in its Linux
+  #       container build environments to mitigate Meltdown/Spectre
+  #       vulnerabilities, at which point Hyrax could no longer use the
+  #       Capybara-provided :selenium_chrome_headless driver (which does not
+  #       include the `--no-sandbox` argument).
+  Capybara.register_driver :selenium_chrome_headless_sandboxless do |app|
+    browser_options = ::Selenium::WebDriver::Chrome::Options.new
+    browser_options.args << '--headless'
+    browser_options.args << '--disable-gpu'
+    browser_options.args << '--no-sandbox'
+    Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+  end
+end
+
+Capybara.default_driver = :rack_test # This is a faster driver
+Capybara.javascript_driver = :selenium_chrome_headless_sandboxless # This is slower
+Capybara.default_max_wait_time = ENV.fetch('CAPYBARA_WAIT_TIME', 10) # We may have a slow application, let's give it some time.
+
+Capybara::Screenshot.register_driver(:selenium_chrome_headless_sandboxless) do |driver, path|
+  driver.browser.save_screenshot(path)
+end
+
+Capybara::Screenshot.autosave_on_failure = false
+Capybara::Screenshot.prune_strategy = { keep: 10 }
+
+# Save CircleCI artifacts
+
+def save_timestamped_page_and_screenshot(page, meta)
+  filename = File.basename(meta[:file_path])
+  line_number = meta[:line_number]
+
+  time_now = Time.zone.now
+  timestamp = "#{time_now.strftime('%Y-%m-%d-%H-%M-%S.')}#{'%03d' % (time_now.usec / 1000).to_i}"
+
+  artifact_dir = ENV['CI'] ? "/tmp/test-results" : Rails.root.join('tmp', 'capybara')
+
+  screenshot_name = "screenshot-#{filename}-#{line_number}-#{timestamp}.png"
+  screenshot_path = "#{artifact_dir}/#{screenshot_name}"
+  page.save_screenshot(screenshot_path)
+
+  page_name = "html-#{filename}-#{line_number}-#{timestamp}.html"
+  page_path = "#{artifact_dir}/#{page_name}"
+  page.save_page(page_path)
+
+  puts "\n  Screenshot: #{screenshot_path}"
+  puts "  HTML: #{page_path}"
+end
+
+RSpec.configure do |config|
+  config.after(:each, :js) do |example|
+    save_timestamped_page_and_screenshot(Capybara.page, example.metadata) if example.exception
+  end
+end

data/lib/hyrax/specs/clamav.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+if defined?(ClamAV)
+  ClamAV.instance.loaddb
+else
+  class ClamAV
+    include Singleton
+    def scanfile(_f)
+      0
+    end
+
+    def loaddb
+      nil
+    end
+  end
+end

data/lib/hyrax/specs/disable_animations_in_test_environment.rb

@@ -0,0 +1,53 @@
+#
+# disable CSS3 and jQuery animations in test mode for speed, consistency and avoiding timing issues.
+# HT: https://gist.github.com/keithtom/8763169
+class DisableAnimationsInTestEnvironment
+  def initialize(app, _options = {})
+    @app = app
+  end
+
+  def call(env)
+    @status, @headers, @body = @app.call(env)
+    return [@status, @headers, @body] unless html?
+    response = Rack::Response.new([], @status, @headers)
+
+    @body.each { |fragment| response.write inject(fragment) }
+    @body.close if @body.respond_to?(:close)
+
+    response.finish
+  end
+
+  private
+
+    def html?
+      @headers["Content-Type"] =~ /html/
+    end
+
+    # rubocop:disable Metrics/MethodLength Layout/IndentHeredoc
+    def inject(fragment)
+      disable_animations = <<-EOF
+<script type="text/javascript">(typeof jQuery !== 'undefined') && (jQuery.fx.off = true);</script>
+<style>
+  * {
+     -o-transition: none !important;
+     -moz-transition: none !important;
+     -ms-transition: none !important;
+     -webkit-transition: none !important;
+     transition: none !important;
+     -o-transform: none !important;
+     -moz-transform: none !important;
+     -ms-transform: none !important;
+     -webkit-transform: none !important;
+     transform: none !important;
+     -webkit-animation: none !important;
+     -moz-animation: none !important;
+     -o-animation: none !important;
+     -ms-animation: none !important;
+     animation: none !important;
+  }
+</style>
+      EOF
+      fragment.gsub(%r{</head>}, disable_animations + "</head>")
+    end
+  # rubocop:enable Metrics/MethodLength Layout/IndentHeredoc
+end

data/lib/hyrax/specs/engine_routes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EngineRoutes
+  def self.included(base)
+    base.routes { Hyrax::Engine.routes }
+  end
+
+  def main_app
+    Rails.application.class.routes.url_helpers
+  end
+end

data/lib/hyrax/specs/shared_specs/change_set.rb

@@ -0,0 +1,11 @@
+require 'valkyrie/specs/shared_specs'
+
+RSpec.shared_examples 'a Hyrax::ChangeSet' do
+  before do
+    raise 'change_set creation requires `let(:resource)`' unless defined? resource
+  end
+
+  subject(:changeset)   { described_class.for(resource) }
+
+  it_behaves_like 'a Valkyrie::ChangeSet'
+end

data/lib/hyrax/specs/shared_specs/factories/strategies/json_strategy.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class JsonStrategy
+  def initialize
+    @strategy = FactoryBot.strategy_by_name(:create).new
+  end
+
+  delegate :association, to: :@strategy
+
+  def result(evaluation)
+    @strategy.result(evaluation).to_json
+  end
+end

data/lib/hyrax/specs/shared_specs/factories/strategies/valkyrie_resource.rb

@@ -19,14 +19,3 @@ class ValkyrieCreateStrategy
     Hyrax.persister
   end
 end
-
-# @see https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#custom-strategies
-# @example
-#   let(:resource) { FactoryBot.create_using_test_adapter(:hyrax_work) }
-class ValkyrieTestAdapterCreateStrategy < ValkyrieCreateStrategy
-  private
-
-  def persister
-    Valkyrie::MetadataAdapter.find(:test_adapter).persister
-  end
-end

data/lib/hyrax/specs/shared_specs/hydra_works.rb

@@ -128,8 +128,14 @@ end
 RSpec.shared_examples 'a Hyrax::PcdmCollection' do
   subject(:collection) { described_class.new }
 
+  it { is_expected.to be_collection }
+  it { is_expected.to be_pcdm_object }
+  it { is_expected.not_to be_file_set }
+  it { is_expected.not_to be_work }
+
   it_behaves_like 'a Hyrax::Resource'
   it_behaves_like 'a model with core metadata'
+  it_behaves_like 'a model with basic metadata'
   it_behaves_like 'has members'
 
   describe '#collection_type_gid' do