hyrax-spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 201d0cd5f1c435e883f7a18f573c14d367490e1b
+  data.tar.gz: a8af2de8319a29318c3da006e60a93b98f6160a9
+SHA512:
+  metadata.gz: 6f01717f038d919a22bf265850c78d8fdadb845cca0e9e34dc5a47d1eeeb08b8f07f1dc9b0561594b1108ea361d3c9d8150bd09116b5e8497b54b47b6032626d
+  data.tar.gz: b524cf308449c9131382e182992b6e96e927c7611d9f40aa8c00a753788302160061973729aab3a8452a2eeef0dba4228c04112da4d06736ae2bf1510da6d754

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+    bixby: bixby_default.yml
+
+# hyrax-spec.gemspec is correct
+Style/FileName:
+  Exclude:
+    - '*.gemspec'
+    - 'Gemfile*'
+    - 'Guardfile*'
+Metrics/BlockLength:
+  Exclude:
+    - '*_spec.rb'
+    - 'lib/hyrax/spec/**/*'

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+dist: trusty
+sudo: false
+
+cache:
+  bundler: true
+
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+
+script:
+  - bundle exec rake
+  
+env:
+  matrix:
+    - "RAILS_VERSION=5.0.3"
+    - "RAILS_VERSION=5.1.1"

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Please see hyrax-spec.gemspec for dependency information.
+gemspec
+
+group :development, :test do
+  gem 'coveralls',   require: false
+  gem 'guard-rspec', require: false
+  gem 'pry'          unless ENV['CI']
+  gem 'pry-byebug'   unless ENV['CI']
+  gem 'simplecov',   require: false
+end

data/Guardfile

@@ -0,0 +1,18 @@
+# A Guardfile
+# More info at https://github.com/guard/guard#readme
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2017 Data Curation Experts, LLC
+
+   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,10 @@
+Hyrax::Spec
+===========
+
+Shared examples and smoke tests for [Hyrax](https://github.com/samvera/hyrax) applications.
+
+## License
+
+`Hyrax::Spec` is available under [the Apache 2.0 license](LICENSE).
+
+

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Check style and run specs'
+task ci: ['rubocop', 'spec']
+
+task default: :ci

data/hyrax-spec.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hyrax/spec/version'
+
+Gem::Specification.new do |spec|
+  spec.authors       = ['Tom Johnson']
+  spec.email         = ['tom@curationexperts.com']
+  spec.description   = 'Shared tests, matchers, and smoke tests for the Hyrax Samvera engine.'
+  spec.summary       = <<-EOF
+  These are some tests and matchers for Hyrax.
+EOF
+
+  spec.homepage      = 'http://github.com/curationexperts/hyrax-spec'
+
+  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.name          = 'hyrax-spec'
+  spec.require_paths = ["lib"]
+  spec.version       = Hyrax::Spec::VERSION
+  spec.license       = 'Apache-2.0'
+
+  spec.add_dependency 'rspec', '~> 3.6'
+
+  spec.add_development_dependency 'bixby', '~> 0.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/hyrax/spec.rb

@@ -0,0 +1,15 @@
+require 'hyrax' # @see http://rubygems.org/gems/hyrax
+require 'rspec' # @see http://rubygems.org/gems/rspec
+
+module Hyrax
+  ##
+  # `Hyrax::Spec` offers shared examples, contexts and matchers for Hyrax and
+  # its components.
+  #
+  # @example Requiring the `Hyrax::Spec` module
+  #   require 'hyrax/spec'
+  #
+  # @see http://rspec.info/documentation
+  module Spec
+  end
+end

data/lib/hyrax/spec/matchers.rb

@@ -0,0 +1,13 @@
+require 'rspec/matchers' # @see http://rubygems.org/gems/rspec
+
+module Myrax
+  module Spec
+    ##
+    # RSpec matchers for common Hyrax tests
+    module Matchers
+      require 'hyrax/spec/matchers/have_editable_property'
+      require 'hyrax/spec/matchers/have_form_field'
+      require 'hyrax/spec/matchers/list_index_fields'
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+RSpec::Matchers.define :have_editable_property do |property, predicate|
+  match do |model|
+    predicate ||= chain_predicate
+    values    = ['Comet in Moominland', 'Moomin Midwinter']
+    values    = values.first if @single
+
+    # find the matching property or set @missing_property to true and fail
+    config = model.class.properties.fetch(property.to_s) do
+      @missing_property = true
+      return false
+    end
+
+    # fail if setting the property doesn't change the values
+    expect { model.set_value(property, values) }
+      .to change { Array(model.get_values(property)) }
+      .to contain_exactly(*values)
+
+    # if we haven't failed yet & we don't need to verify the predicate, succeed.
+    return true unless predicate
+
+    # cast the predicate to a URI
+    predicate = RDF::URI.intern(predicate)
+
+    # fail if the configured predicate is wrong
+    @actual_predicate = config.predicate
+    return false unless @actual_predicate == predicate
+
+    # fail if the rdf doesn't have the correct statements
+    Array(values).each do |value|
+      expect(model.resource.statements)
+        .to include(RDF::Statement(model.rdf_subject, predicate, value))
+    end
+  end
+
+  chain :with_predicate, :chain_predicate
+
+  chain :as_single_valued do
+    @single = true
+  end
+
+  failure_message do |model|
+    msg = "expected #{model.class} to have an editable property `#{property}`"
+    msg += " with predicate #{predicate.to_base}." if predicate
+
+    return msg + "\n\tNo property for `#{property}` was found." if @missing_property
+
+    msg += "\n\tThe configured predicate was #{actual_predicate.to_base}" unless
+      @actual_predicate == predicate
+    msg
+  end
+end

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

@@ -0,0 +1,70 @@
+RSpec::Matchers.define :have_form_field do |name|
+  match do |rendered_form|
+    raise 'Specify a model with `.on_model(Klass)` to use this matcher.' unless
+      model_class
+
+    @selector = "#{model_class.to_s.downcase}_#{name}"
+    @field    = rendered_form.find_css("##{@selector}").first
+
+    @options_missing = []
+
+    return false unless @field
+
+    @multiple = case @field.node_name
+                when 'input'
+                  @field.attributes['class'].value.include? 'multi_value'
+                when 'select'
+                  @field.attributes['multiple']
+                end
+
+    if label
+      label_node   = rendered_form.find_css("label[for=\"#{@selector}\"]")
+      @label_text  = label_node && label_node.xpath('text()').first.text
+      @label_match = @label_text =~ /\s*#{label}\s*$/
+    end
+
+    if @options
+      @option_values =
+        @field.css('option').map { |opt| opt.attributes['value'].try(:value) }
+      @options_missing = (@options - @option_values)
+    end
+
+    @field &&
+      (@single ^ @multiple) &&
+      (!label || @label_match) &&
+      @options_missing.empty?
+  end
+
+  chain :on_model,   :model_class
+  chain :and_label,  :label
+  chain :with_label, :label
+
+  chain :as_single_valued do
+    @single = true
+  end
+
+  chain :and_options do |*options|
+    @options = options
+  end
+
+  chain :with_options do |*options|
+    @options = options
+  end
+
+  failure_message do |rendered_form|
+    msg = "expected #{rendered_form} to have field #{name}"
+    msg += ' as ' + (@single ? 'single valued' : 'multivalued')
+    msg += " for class #{model_class}"          if     model_class
+    msg += " with label #{label}"               if     label
+    msg += " with options #{@options}"          if     @options
+    msg += "\n\tNo field found: #{@selector}."  unless @field
+    msg += "\n\tField not multivalued."         unless @single || @multiple
+    msg += "\n\tField not single valued."       if     @single && @multiple
+    msg += "\n\tLabel was #{@label_text}."      unless @label_match && @field
+    msg += "\n\tOptions were #{@option_values}" unless @options_missing.empty?
+    msg += "\n\t#{@field}."                     if     @field
+    msg
+  end
+end
+
+RSpec::Matchers.alias_matcher :have_multivalued_field, :have_form_field

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

@@ -0,0 +1,30 @@
+RSpec::Matchers.define :list_index_fields do |*names|
+  match do |rendered_view|
+    @missing_names = decorated_names(names) - labels_for(rendered_view)
+    @missing_names.empty?
+  end
+
+  match_when_negated do |rendered_view|
+    @missing_names = decorated_names(names) - labels_for(rendered_view)
+    @not_missing = (decorated_names(names) - @missing_names)
+    @not_missing.empty?
+  end
+
+  def decorated_names(names)
+    names.map { |name| name.end_with?(':') ? name : name + ':' }
+  end
+
+  def labels_for(view)
+    view.find('.metadata').all('.attribute-label').map(&:text)
+  end
+
+  failure_message do |rendered_view|
+    msg = "expected #{rendered_view} to list index fields #{names}"
+    msg + "\n\tthe fields #{@missing_names} were not present."
+  end
+
+  failure_message_when_negated do |rendered_view|
+    msg = "expected #{rendered_view} not to list index fields #{names}"
+    msg + "\n\tbut #{@not_missing} were present."
+  end
+end

data/lib/hyrax/spec/version.rb

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

data/spec/hyrax/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'hyrax'

data/spec/hyrax/spec/version_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Hyrax::Spec::VERSION do
+  it { is_expected.to be_a String }
+end

data/spec/hyrax/spec_spec.rb

@@ -0,0 +1,5 @@
+describe Hyrax::Spec do
+  it 'exists' do
+    described_class
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'bundler/setup'
+
+begin
+  require 'simplecov'
+  require 'coveralls'
+rescue LoadError => e
+  STDERR.puts "Coverage Skipped: #{e.message}"
+end
+
+begin
+  require 'pry' unless ENV['CI']
+rescue LoadError => e
+  STDERR.puts "Couldn't load Pry: #{e.message}"
+end
+
+RSpec.configure do |config|
+  config.filter_run_excluding :slow
+  config.run_all_when_everything_filtered = true
+
+  # disable should syntax
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: hyrax-spec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: bixby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shared tests, matchers, and smoke tests for the Hyrax Samvera engine.
+email:
+- tom@curationexperts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- hyrax-spec.gemspec
+- lib/hyrax/spec.rb
+- lib/hyrax/spec/matchers.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/version.rb
+- spec/hyrax/spec/spec_helper.rb
+- spec/hyrax/spec/version_spec.rb
+- spec/hyrax/spec_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/curationexperts/hyrax-spec
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: These are some tests and matchers for Hyrax.
+test_files:
+- spec/hyrax/spec/spec_helper.rb
+- spec/hyrax/spec/version_spec.rb
+- spec/hyrax/spec_spec.rb
+- spec/spec_helper.rb