hyrax-spec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 201d0cd5f1c435e883f7a18f573c14d367490e1b
-  data.tar.gz: a8af2de8319a29318c3da006e60a93b98f6160a9
+  metadata.gz: 56f98b28611537d25097f62fbb3fc0a29134a528
+  data.tar.gz: 05bbf255025da7828354c8c789066666fbd7cedc
 SHA512:
-  metadata.gz: 6f01717f038d919a22bf265850c78d8fdadb845cca0e9e34dc5a47d1eeeb08b8f07f1dc9b0561594b1108ea361d3c9d8150bd09116b5e8497b54b47b6032626d
-  data.tar.gz: b524cf308449c9131382e182992b6e96e927c7611d9f40aa8c00a753788302160061973729aab3a8452a2eeef0dba4228c04112da4d06736ae2bf1510da6d754
+  metadata.gz: a56166d2f65ffaffced6e014e655564804f9f80bfd154b2de60c64b5a1f3d41a0629c7cc2f49317c7f94719be3531d377309506a35ecd9e3bf1e0d8c442a3a42
+  data.tar.gz: c7e4601bc82514dd2d978806bb9453f05d11bd6ae17e9bcaa55404b5e2a5f281b60bc7e22c47021102787b710fefceb2304bd04b4cc0e5668908f848d8d1c523

data/.gitignore

@@ -1 +1,3 @@
+*.log
+*.gem
 Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+
+v0.2.0 -- 2017-11-21
+--------------------
+
+ - Introduce shared examples for Hyrax metadata
+   - 'a model with hyrax core metadata'
+   - 'a model with hyrax basic metadata'
+ - Add `acts` matcher for testing `Hyrax::Actors` c56248d
+ - Bugfix for `have_editable_property` failure reporting. 3a5af61
+
+v0.1.0 -- 2017-11-07
+--------------------
+
+ - Initial Release
+ - Add initial Hyrax matchers
+    - `have_editable_property`
+    - `have_form_field`
+    - `list_index_fields`

data/lib/hyrax/spec/matchers.rb

@@ -5,6 +5,7 @@ module Myrax
     ##
     # RSpec matchers for common Hyrax tests
     module Matchers
+      require 'hyrax/spec/matchers/act'
       require 'hyrax/spec/matchers/have_editable_property'
       require 'hyrax/spec/matchers/have_form_field'
       require 'hyrax/spec/matchers/list_index_fields'

data/lib/hyrax/spec/matchers/act.rb

@@ -0,0 +1,79 @@
+RSpec::Matchers.define :act do
+  fake_actor = Class.new do
+    attr_reader :created, :updated, :destroyed
+
+    def create(*)
+      @created = true
+    end
+
+    def update(*)
+      @updated = true
+    end
+
+    def destroy(*)
+      @destroyed = true
+    end
+  end
+
+  fail_actor = Class.new do
+    def create(*)
+      false
+    end
+
+    def update(*)
+      false
+    end
+
+    def destroy(*)
+      false
+    end
+  end
+
+  match do |actor_class|
+    env       ||= instance_double(Hyrax::Actors::Environment, curation_concern: nil)
+    @next_actor = fake_actor.new
+    actor       = actor_class.new(@next_actor)
+    @create     = actor.create(env)
+    @update     = actor.update(env)
+    @destroy    = actor.destroy(env)
+
+    failure_actor = actor_class.new(fail_actor.new)
+    @fail_create  = failure_actor.create(env)
+    @fail_update  = failure_actor.update(env)
+    @fail_destroy = failure_actor.destroy(env)
+
+    return false unless @next_actor.created && @next_actor.updated && @next_actor.destroyed
+    return false unless (@succeed && @create && @update && @destroy) ||
+                        (!@succeed && !@create && !@update && !@destroy)
+    return false unless (!@recover && !@fail_create && !@fail_update && !@fail_destroy) ||
+                        (@recover && @fail_create && @fail_update && @fail_destroy)
+    true
+  end
+
+  chain :and_succeed do
+    @succeed = true
+  end
+
+  chain :and_recover do
+    @recover = true
+  end
+
+  chain :with_env, :env
+
+  failure_message do |actor|
+    msg = "expected #{actor.class} to behave like a Hyrax::Actor but"
+    msg += "\n\t#create returned #{@create}"                     unless @create == true || !@succeed
+    msg += "\n\t#create was not called on the next actor"        unless @next_actor.created
+    msg += "\n\tunexpectedly recovered from failure on #create"  unless @recover || !@fail_create
+    msg += "\n\tdid not recover from failure on #create"         unless !@recover || @fail_create
+    msg += "\n\t#update returned #{@update}"                     unless @update == true || !@succeed
+    msg += "\n\t#update was not called on the next actor"        unless @next_actor.updated
+    msg += "\n\tunexpectedly recovered from failure on #update"  unless @recover || !@fail_update
+    msg += "\n\tdid not recover from failure on #update"         unless !@recover || @fail_update
+    msg += "\n\t#destroy returned #{@destroy}"                   unless @destroy == true || !@succeed
+    msg += "\n\t#destroy was not called on the next actor"       unless @next_actor.destroyed
+    msg += "\n\tunexpectedly recovered from failure on #destroy" unless @recover || !@fail_destroy
+    msg += "\n\tdid not recover from failure on #destroy"        unless !@recover || @fail_destroy
+    msg
+  end
+end

data/lib/hyrax/spec/matchers/have_editable_property.rb

@@ -44,7 +44,7 @@ RSpec::Matchers.define :have_editable_property do |property, predicate|
 
     return msg + "\n\tNo property for `#{property}` was found." if @missing_property
 
-    msg += "\n\tThe configured predicate was #{actual_predicate.to_base}" unless
+    msg += "\n\tThe configured predicate was #{@actual_predicate.to_base}" unless
       @actual_predicate == predicate
     msg
   end

data/lib/hyrax/spec/shared_examples.rb

@@ -0,0 +1,7 @@
+module Hyrax
+  module Spec
+    module SharedExamples
+      require 'hyrax/spec/shared_examples/basic_metadata'
+    end
+  end
+end

data/lib/hyrax/spec/shared_examples/basic_metadata.rb

@@ -0,0 +1,159 @@
+RSpec.shared_examples 'a model with hyrax core metadata' do |**opts|
+  subject(:model) { described_class.new }
+  let(:except)    { Array(opts[:except]) }
+
+  it do
+    skip if except.include?(:date_modified)
+    is_expected
+      .to have_editable_property(:date_modified)
+      .with_predicate(RDF::Vocab::DC.modified)
+      .as_single_valued
+  end
+
+  it do
+    skip if except.include?(:date_uploaded)
+    is_expected
+      .to have_editable_property(:date_uploaded)
+      .with_predicate(RDF::Vocab::DC.dateSubmitted)
+      .as_single_valued
+  end
+
+  it do
+    skip if except.include?(:depositor)
+    is_expected
+      .to have_editable_property(:depositor)
+      .with_predicate(RDF::Vocab::MARCRelators.dpt)
+      .as_single_valued
+  end
+
+  describe '#first_title' do
+    it 'is nil when empty' do
+      skip if except.include?(:first_title) || except.include?(:title)
+      expect(model.first_title).to be_nil
+    end
+
+    it 'is a single title' do
+      skip if except.include?(:first_title) || except.include?(:title)
+      expect { model.title = ['Comet in Moominland', 'Moomin Midwinter'] }
+        .to change { model.first_title }
+        .to an_instance_of(String)
+    end
+  end
+
+  it do
+    skip if except.include?(:title)
+    is_expected.to have_editable_property(:title, RDF::Vocab::DC.title)
+  end
+end
+
+RSpec.shared_examples 'a model with hyrax basic metadata' do |**opts|
+  subject(:model) { described_class.new }
+  let(:except)    { Array(opts[:except]) }
+
+  it_behaves_like 'a model with hyrax core metadata', opts
+
+  it do
+    skip if except.include?(:label)
+    is_expected
+      .to have_editable_property(:label)
+      .with_predicate('info:fedora/fedora-system:def/model#downloadFilename')
+      .as_single_valued
+  end
+
+  it do
+    skip if except.include?(:relative_path)
+    is_expected
+      .to have_editable_property(:relative_path)
+      .with_predicate('http://scholarsphere.psu.edu/ns#relativePath')
+      .as_single_valued
+  end
+
+  it do
+    skip if except.include?(:import_url)
+    is_expected
+      .to have_editable_property(:import_url)
+      .with_predicate('http://scholarsphere.psu.edu/ns#importUrl')
+      .as_single_valued
+  end
+
+  it do
+    skip if except.include?(:bibliographic_citation)
+    is_expected.to have_editable_property(:bibliographic_citation, RDF::Vocab::DC.bibliographicCitation)
+  end
+
+  it do
+    skip if except.include?(:contributor)
+    is_expected.to have_editable_property(:contributor, RDF::Vocab::DC11.contributor)
+  end
+
+  it do
+    skip if except.include?(:creator)
+    is_expected.to have_editable_property(:creator, RDF::Vocab::DC11.creator)
+  end
+
+  it do
+    skip if except.include?(:date_created)
+    is_expected.to have_editable_property(:date_created, RDF::Vocab::DC.created)
+  end
+
+  it do
+    skip if except.include?(:description)
+    is_expected.to have_editable_property(:description, RDF::Vocab::DC11.description)
+  end
+
+  it do
+    skip if except.include?(:identifier)
+    is_expected.to have_editable_property(:identifier, RDF::Vocab::DC.identifier)
+  end
+
+  it do
+    skip if except.include?(:keyword)
+    is_expected.to have_editable_property(:keyword, RDF::Vocab::DC11.relation)
+  end
+
+  it do
+    skip if except.include?(:language)
+    is_expected.to have_editable_property(:language, RDF::Vocab::DC11.language)
+  end
+
+  it do
+    skip if except.include?(:license)
+    is_expected.to have_editable_property(:license, RDF::Vocab::DC.rights)
+  end
+
+  it do
+    skip if except.include?(:publisher)
+    is_expected.to have_editable_property(:publisher, RDF::Vocab::DC11.publisher)
+  end
+
+  it do
+    skip if except.include?(:related_url)
+    is_expected.to have_editable_property(:related_url, RDF::RDFS.seeAlso)
+  end
+
+  it do
+    skip if except.include?(:resource_type)
+    is_expected.to have_editable_property(:resource_type, RDF::Vocab::DC.type)
+  end
+
+  it do
+    skip if except.include?(:rights_statement)
+    is_expected.to have_editable_property(:rights_statement, RDF::Vocab::EDM.rights)
+  end
+
+  it do
+    skip if except.include?(:source)
+    is_expected.to have_editable_property(:source, RDF::Vocab::DC.source)
+  end
+
+  it do
+    skip if except.include?(:subject)
+    is_expected.to have_editable_property(:subject, RDF::Vocab::DC11.subject)
+  end
+
+  describe '#based_near' do
+    it 'builds as a location'
+    it 'is controlled'
+    it 'accepts nested attributes'
+  end
+end

data/lib/hyrax/spec/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyrax-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -70,9 +71,12 @@ files:
 - hyrax-spec.gemspec
 - lib/hyrax/spec.rb
 - lib/hyrax/spec/matchers.rb
+- lib/hyrax/spec/matchers/act.rb
 - lib/hyrax/spec/matchers/have_editable_property.rb
 - lib/hyrax/spec/matchers/have_form_field.rb
 - lib/hyrax/spec/matchers/list_index_fields.rb
+- lib/hyrax/spec/shared_examples.rb
+- lib/hyrax/spec/shared_examples/basic_metadata.rb
 - lib/hyrax/spec/version.rb
 - spec/hyrax/spec/spec_helper.rb
 - spec/hyrax/spec/version_spec.rb