hyrax-spec 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56f98b28611537d25097f62fbb3fc0a29134a528
-  data.tar.gz: 05bbf255025da7828354c8c789066666fbd7cedc
+  metadata.gz: 387b76ffb416aa87c56d3af3b5b9e3566e3e0628
+  data.tar.gz: e56c6f049baf9e5da3f3448642b2335cea1f3a5c
 SHA512:
-  metadata.gz: a56166d2f65ffaffced6e014e655564804f9f80bfd154b2de60c64b5a1f3d41a0629c7cc2f49317c7f94719be3531d377309506a35ecd9e3bf1e0d8c442a3a42
-  data.tar.gz: c7e4601bc82514dd2d978806bb9453f05d11bd6ae17e9bcaa55404b5e2a5f281b60bc7e22c47021102787b710fefceb2304bd04b4cc0e5668908f848d8d1c523
+  metadata.gz: 20e0e71dfb0ac50e471d30d5c792339a02b5ef8f7f45652c80d29988c7411981f58a6df4944fc6f0805818ec45b98474dfd4c3d0fadfdb05a823287689e0053f
+  data.tar.gz: d06bba5e9d9378edd4195ab21521c18a4aa2425b4b1c53b0d9d2cd0284d0c38d6d8c89bcb8a04be63703da5752e64905fde2f1e7e125daae104d411eef9536d6

data/README.md

@@ -3,8 +3,48 @@ Hyrax::Spec
 
 Shared examples and smoke tests for [Hyrax](https://github.com/samvera/hyrax) applications.
 
-## License
+## `FactoryBot` Build Strategies for Hyrax
 
-`Hyrax::Spec` is available under [the Apache 2.0 license](LICENSE).
+If your test suite uses `FactoryBot` (formerly `FactoryGirl`) to create test objects, `Hyrax::Spec` provides useful
+custom build strategies that may simplify the setup phase of your tests. To register the build stratgies add the
+following to your test helper (usually `spec/rails_helper.rb`):
+
+```ruby
+# spec/rails_helper.rb
+
+require 'hyrax/spec/factory_bot/build_strategies'
+```
+
+### `ActorCreate`
+
+The `ActorCreate` strategy builds an object and passes it to the [Hyrax Actor
+Stack](https://github.com/samvera/hyrax/wiki/Customizing-Actors) to be processed. In a normal RSpec Rails environment,
+this will  enqueue (but not perform) several background jobs (charactarization, derivatives, etc...). The specific actor
+middleware called is `Hyrax::CurationConcern.actor`.
+
+This strategy is registered by default as `actor_create`. You can use it with an existing factory, which must define
+`user` as a [transient attribute](https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#transient).
 
+```ruby
+# factories/my_works.rb
+FactoryBot.define do
+  factory(:my_work) do
+    title ['Comet in Moominland']
 
+    transient do
+      user { FactoryBot.create(:user) }
+    end
+  end
+end
+
+# my_work_spec.rb
+RSpec.describe MyWork do
+  subject(:my_work) { FactoryBot.actor_create(:my_work) }
+
+  it { is_expected.to have_attributes(date_uploaded: an_instance_of(DateTime)) }
+end
+```
+
+## License
+
+`Hyrax::Spec` is available under [the Apache 2.0 license](LICENSE).

data/lib/hyrax/spec/factory_bot/build_strategies.rb

@@ -0,0 +1,12 @@
+module Hyrax
+  module Spec
+    if defined?(FactoryBot) || defined?(FactoryGirl)
+      # support legacy FactoryGirl name, but use always FactoryBot internally
+      FactoryBot = FactoryGirl unless defined?(FactoryBot)
+
+      require 'hyrax/spec/factory_bot/build_strategies/actor_create'
+
+      FactoryBot.register_strategy(:actor_create, Hyrax::Spec::ActorCreate)
+    end
+  end
+end

data/lib/hyrax/spec/factory_bot/build_strategies/actor_create.rb

@@ -0,0 +1,50 @@
+module Hyrax
+  module Spec
+    ##
+    # A FactoryBot build strategy for creating Hyrax Works and running them
+    # through the actor stack.
+    #
+    # In a normal RSpec Rails environment, this will  enqueue (but not perform)
+    # several background jobs (charactarization, derivatives, etc...). If you
+    # want to perform the jobs, configure that with:
+    #
+    #     ActiveJob::Base.queue_adapter.perform_enqueued_jobs    = true
+    #     ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
+    #
+    # If you only want to perform specific job classes, you can do:
+    #
+    #     ActiveJob::Base.queue_adapter.filter = [SpecificJobClassYouWantToRun]
+    #
+    # @example Registering the strategy and creating using an existing factory
+    #   FactoryBot.register_strategy(:actor_create, ActorCreate)
+    #
+    #   work = FactoryBot.actor_create(:a_work_factory)
+    #
+    # @see Hyrax::CurationConcern#actor
+    # @see https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#custom-strategies
+    class ActorCreate
+      def initialize
+        @association_strategy = FactoryBot.strategy_by_name(:create).new
+      end
+
+      delegate :association, to: :@association_strategy
+
+      def result(evaluation)
+        evaluation.object.tap do |instance|
+          evaluation.notify(:after_build, instance)
+
+          # @todo: is there a better way to get the evaluator at this stage?
+          #   how should we handle a missing user?
+          ability = ::Ability.new(evaluation.instance_variable_get(:@evaluator).user)
+          env     = Hyrax::Actors::Environment.new(instance, ability, {})
+
+          evaluation.notify(:before_create,       instance)
+          evaluation.notify(:before_actor_create, instance)
+          Hyrax::CurationConcern.actor.create(env)
+          evaluation.notify(:after_create,       instance)
+          evaluation.notify(:after_actor_create, instance)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/spec/version.rb

@@ -1,5 +1,5 @@
 module Hyrax
   module Spec
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyrax-spec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tom Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -70,6 +70,8 @@ files:
 - Rakefile
 - hyrax-spec.gemspec
 - lib/hyrax/spec.rb
+- lib/hyrax/spec/factory_bot/build_strategies.rb
+- lib/hyrax/spec/factory_bot/build_strategies/actor_create.rb
 - lib/hyrax/spec/matchers.rb
 - lib/hyrax/spec/matchers/act.rb
 - lib/hyrax/spec/matchers/have_editable_property.rb