krikri-spec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c90100ad41d132172efa4c7b439ad6d3f7d718e
+  data.tar.gz: 91d6e0a071fc07e6c7ada9b30cc26746806f832d
+SHA512:
+  metadata.gz: efa17e2c29eb457298abfea52916951f090ed7f3029504f16c6f955f79899ba6f8f17ad16501811191b17a91000e6c377f665fbe880af73a1e818c99eade49cd
+  data.tar.gz: 640d3bc1484d119795ca63c7c1bc1730146af9e56a0b7a5bf759abb4ce3025addf13937fbbd86cb332996d2d78308b32be7f3833391cb1268731255e698e3298

data/README.md

@@ -0,0 +1,71 @@
+Krikri::Spec
+============
+
+[![Build Status](https://travis-ci.org/dpla/krikri-spec.svg?branch=develop)](https://travis-ci.org/dpla/krikri-spec)
+
+RSpec extensions and shared examples for Krikri.
+
+Shared Examples
+----------------
+
+Shared examples are included as linters for Krikri contracts. Use the shared
+examples within individual spec files by invoking them in place:
+
+```ruby
+require 'krikri/spec/harvester'
+
+describe MyHarvester do
+  it_behaves_like 'a harvester'
+end
+```
+
+Matchers
+--------
+
+Matchers for some common patterns within specs for Krikri apps are provided.
+You can include them in your RSpec enviornment with:
+
+```ruby
+require 'krikri/spec
+
+RSpec.configure do |conf|
+  conf.include(Krikri::Spec::Matchers)
+end
+```
+
+Development
+-----------
+
+When working on the Krikri gem, it is often useful to work directly against a
+local copy of the `Krikri::Spec` examples. To do this, you can add a local path
+to your Krikri Gemfile:
+
+```ruby
+# Gemfile
+
+gem 'krikri-spec', path: '../krikri-spec'
+```
+
+Or run against the `develop` branch on GitHub:
+
+```ruby
+# Gemfile
+
+gem 'krikri-spec', github: 'dpla/krikri-spec', branch: 'develop'
+```
+
+Contribution Guidelines
+-----------------------
+Please observe the following guidelines:
+
+  - Write tests for your contributions.
+  - Document methods you add using YARD annotations.
+  - Follow the included style guidelines (i.e. run `rubocop` before committing).
+  - Use well formed commit messages.
+
+Copyright & License
+--------------------
+
+  - Copyright Digital Public Library of America, 2016
+  - License: MIT
+  

data/lib/krikri/spec.rb

@@ -0,0 +1,38 @@
+##
+# `Krikri::Spec` offers RSpec extensions and shared examples for the Krikri
+# metadata aggregation engine.
+#
+# Shared examples must be required explictly for specs that use them. This helps
+# with clarity of shared example use, and avoids namespace pollution for
+# `it_behaves_like` directives.
+#
+# @example using a shared example
+#   require 'krikri/spec/harvester'
+#
+#   describe MyHarvester do
+#     it_behaves_like 'a harvester'
+#   end
+#
+#
+# RSpec matchers are included for common checks within Krikri based
+# applications.
+#
+# @example using a custom matcher
+#   require 'krikri/spec'
+#
+#   RSpec.configure { |conf| conf.include(Krikri::Spec::Matchers) }
+#
+#   describe SomeModel do
+#     it 'is an exactMatch for moomin' do
+#       moomin = RDF::URI('http://example.com/moomin')
+#
+#       expect(subject).to be_exact_match_with moomin
+#     end
+#   end
+#
+# @see http://www.rubydoc.info/gems/krikri
+# @see http://rspec.info/
+module Krikri::Spec
+  autoload :Matchers, 'krikri/spec/matchers'
+  autoload :VERSION,  'krikri/spec/version'
+end

data/lib/krikri/spec/harvester.rb

@@ -0,0 +1,136 @@
+require 'krikri/spec/software_agent'
+
+shared_examples 'a harvester' do
+  opts = { uri: 'http://example.org/endpoint' }
+  it_behaves_like 'a software agent', opts
+
+  let(:harvester) { subject }
+  let(:name) { :test_harvester }
+
+  it { expect(described_class.queue_name.to_s).to eq 'harvest' }
+
+  it 'is a harvester' do
+    expect(harvester).to be_a Krikri::Harvester
+  end
+
+  it 'raises an error if no uri is given' do
+    expect { described_class.new }.to raise_error KeyError
+  end
+
+  xit 'has a record count' do
+    expect(harvester.count).to be_a Integer
+  end
+
+  describe '#record_ids' do
+    it 'can get its record ids' do
+      expect(harvester.record_ids).to be_a Enumerator
+    end
+
+    it 'gives ids as strings' do
+      harvester.record_ids.each { |i| expect(i).to be_a String }
+    end
+  end
+
+  describe 'local_name creation' do
+    before { harvester.name = name }
+
+    let(:gen_id) { 'my_id' }
+
+    it 'mints md5 identifiers with #records' do
+      expect(Krikri::Md5Minter).to receive(:create)
+        .with(harvester.record_ids.first,
+              harvester.name)
+        .and_return(gen_id)
+
+      expect(harvester.records.first.local_name).to eq gen_id
+    end
+
+    it 'mints md5 identifiers with #get_record' do
+      expect(Krikri::Md5Minter).to receive(:create)
+        .with(harvester.record_ids.first, harvester.name)
+        .and_return(gen_id)
+      expect(harvester.get_record(harvester.record_ids.first).local_name)
+        .to eq gen_id
+    end
+  end
+
+  describe '.expected_opts' do
+    it 'returns a hash with key and options' do
+      expect(described_class.expected_opts)
+        .to match a_hash_including(:key =>  an_instance_of(Symbol),
+                                   :opts => an_instance_of(Hash))
+    end
+  end
+
+  describe '#records' do
+    it 'returns a record enumerator' do
+      expect(subject.records).to be_a Enumerator
+    end
+
+    it 'returns OriginalRecords' do
+      subject.records.each { |r| expect(r).to be_a Krikri::OriginalRecord }
+    end
+
+    context 'after first harvest' do
+      it 'builds same record' do
+        r = subject.records.first
+        r.save
+        expect(subject.records.first).to be == r
+      end
+
+      it 'idempotent reharvests' do
+        subject.records.each(&:save)
+        records = subject.records
+        records_2 = subject.records
+        loop do
+          r1 = records.next
+          r2 = records_2.next
+          expect(r1).to be == r2
+        end
+      end
+    end
+  end
+
+  describe '#get_record' do
+    it 'gets an individual record' do
+      expect(harvester.get_record(harvester.record_ids.first))
+        .to be_a Krikri::OriginalRecord
+    end
+
+    it 'escapes identifiers' do
+      expect(subject.records.first.local_name).not_to include(':')
+    end
+
+    it 'returns a normalized record' do
+      expect(harvester.get_record(harvester.record_ids.first).content)
+        .to eq harvester.records.first.content
+    end
+  end
+
+  describe '#run' do
+    before do
+      allow(harvester).to receive(:records)
+        .and_return [double('Original Record 1'),
+                     double('Record 2')]
+    end
+
+    let(:activity_uri) { RDF::URI('http://example.org/prov/activity/1') }
+
+    it 'processes the OriginalRecords' do
+      harvester.records.each do |r|
+        expect(harvester).to receive(:process_record).with(r, activity_uri)
+          .and_return(true)
+      end
+      harvester.run(activity_uri)
+    end
+  end
+
+  describe '#name' do
+    it 'has name accessors' do
+      harvester.name = name
+      expect(subject).to have_attributes(:name => name)
+    end
+  end
+
+  it_behaves_like 'a software agent', uri: 'http://example.org/endpoint'
+end

data/lib/krikri/spec/matchers.rb

@@ -0,0 +1,35 @@
+require 'rspec/matchers'
+
+module Krikri::Spec
+  ##
+  # Defines matchers for Krikri
+  #
+  # @see http://rubygems.org/gems/rspec
+  # @see http://www.rubydoc.info/gems/rspec-expectations/RSpec/Matchers
+  module Matchers
+    # @!group ActiveTriples Matchers
+
+    ##
+    # Match on the `skos:exactMatch` relation.
+    RSpec::Matchers.define :be_exact_match_with do |expected|
+      match do |actual|
+        exact_match = RDF::URI('http://www.w3.org/2004/02/skos/core#exactMatch')
+        !actual.first([actual, exact_match, expected]).nil?
+      end
+    end
+
+    ##
+    # Match on the `dpla:providedLabel` relation.
+    RSpec::Matchers.define :have_provided_label do |expected|
+      match do |actual|
+        provided_label = RDF::URI('http://dp.la/about/map/providedLabel')
+        pattern = [actual, provided_label, nil]
+
+        expect(actual.query(pattern).map(&:object)).to include(expected)
+        true
+      end
+    end
+
+    # @!endgroup
+  end
+end

data/lib/krikri/spec/software_agent.rb

@@ -0,0 +1,73 @@
+
+shared_examples 'a software agent' do |args|
+  subject { args.nil? ? described_class.new : described_class.new(args) }
+  let(:agent_class) { described_class }
+
+  it 'represents its agent name as the correct string, as a class' do
+    expect(agent_class.agent_name)
+      .to eq agent_class.to_s
+  end
+
+  it 'represents its agent name as the correct string, as an instance' do
+    expect(subject.agent_name).to eq agent_class.to_s
+  end
+
+  describe '.agent_name' do
+    it { expect(agent_class.agent_name).to be_a String }
+  end
+
+  describe '.queue_name' do
+    it { expect(agent_class.queue_name).to respond_to :to_s }
+
+    it 'is lowercase' do
+      expect(agent_class.queue_name).to eq agent_class.queue_name.downcase
+    end
+  end
+
+  describe '#agent_name' do
+    it { expect(subject.agent_name).to be_a String }
+  end
+
+  describe '#run' do
+    it 'accepts one or no arguments' do
+      expect(subject.method(:run).arity).to satisfy { |v| v == -1 || v == 0 }
+    end
+  end
+
+  describe '#enqueue' do
+    let(:queue_name) { described_class.queue_name.to_s }
+
+    it 'accepts options hash as first arg' do
+      expect(agent_class.enqueue({})).to be true
+    end
+
+    it 'accepts options hash as second arg' do
+      expect(agent_class.enqueue('my_queue', {})).to be true
+    end
+
+    it 'throws an error if too many args are given' do
+      expect { agent_class.enqueue('my_queue', {}, :abc) }
+        .to raise_error ArgumentError
+    end
+
+    it 'throws an error if second arg is not options hash' do
+      expect { agent_class.enqueue(:my_queue, :abc) }
+        .to raise_error ArgumentError
+    end
+
+    it 'enqueues a job' do
+      expect { agent_class.enqueue(args) }
+        .to change { Resque.size(queue_name) }.by(1)
+    end
+
+    it 'creates a new activity when it enqueues a job' do
+      expect { agent_class.enqueue(args) }
+        .to change { Krikri::Activity.count }.by(1)
+    end
+
+    it 'logs queue creation' do
+      expect(Rails.logger).to receive(:info).exactly(2).times
+      agent_class.enqueue(args)
+    end
+  end
+end

data/lib/krikri/spec/version.rb

@@ -0,0 +1,5 @@
+module Krikri
+  module Spec
+    VERSION = '0.0.1'.freeze
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+
+require 'krikri/spec'
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = :progress
+  config.mock_with :rspec
+
+  config.include FactoryGirl::Syntax::Methods
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: krikri-spec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Audrey Altman
+- Mark Breedlove
+- Tom Johnson
+- Mark Matienzo
+- Scott Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: krikri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Sharable test suite components for apps based on the Krikri engine.
+email:
+- tech@dp.la
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/krikri/spec.rb
+- lib/krikri/spec/harvester.rb
+- lib/krikri/spec/matchers.rb
+- lib/krikri/spec/software_agent.rb
+- lib/krikri/spec/version.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dpla/krikri-spec
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Shared tests for Krikri's metadata aggregation, enhancement, and quality
+  control functionality.
+test_files:
+- spec/spec_helper.rb
+has_rdoc: