speedy-af 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9543a6894a435f975c44ed9bd36e06c94210221a
+  data.tar.gz: fc8a10a2b7ddb4dbcc0ac34ae5b3b6dbfa363814
+SHA512:
+  metadata.gz: c109886552ed1cee26065b2a81edb34f844877a153591045cbaadc2d2ff11e7b8d366959667062d3a717248a0e82b518c64c611ea0a5f4c02f767a1ebf4b7106
+  data.tar.gz: 41b7a88ff6a723b158864541af9d645c7eff332112a789404f20e857acc25e77dc447990aa4d6a1a389cc6b4f4d1f2932caf99355c5998ee59ba44d286bfcc1f

data/.gitignore

@@ -0,0 +1,4 @@
+coverage
+fcrepo4-test-data
+Gemfile.lock
+config

data/.rubocop.yml

@@ -0,0 +1,178 @@
+require: rubocop-rspec
+
+inherit_from:
+- .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.2
+  DisplayCopNames: true
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - 'script/**/*'
+    - 'vendor/**/*'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/unit/**/*'
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Exclude:
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+  Severity: warning
+  Exclude:
+
+Metrics/PerceivedComplexity:
+  Exclude:
+
+Metrics/ModuleLength:
+  Exclude:
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/MethodName:
+  Exclude:
+
+Style/AndOr:
+  Exclude:
+
+Style/AccessorMethodName:
+  Exclude:
+
+Style/PredicateName:
+  Exclude:
+
+Style/GuardClause:
+  Exclude:
+
+Style/TrivialAccessors:
+  Exclude:
+
+Style/EachWithObject:
+  Exclude:
+
+Style/CaseEquality:
+  Exclude:
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Style/BlockEndNewline:
+  Exclude:
+    - 'spec/**/*'
+
+Style/MultilineBlockLayout:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Semicolon:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Lambda:
+  Exclude:
+    - 'spec/**/*'
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/WordArray:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/GlobalVars:
+  Exclude:
+    - 'spec/**/*'
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/ClassVars:
+  Exclude:
+
+Style/SignalException:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - 'lib/speedy-af.rb'
+
+Style/ZeroLengthPredicate:
+  Exclude:
+
+Performance/RedundantMerge:
+  Exclude:
+
+Rails:
+  Enabled: true
+
+Rails/Output:
+  Exclude:
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/ExampleWording:
+  CustomTransform:
+    be: is
+    have: has
+    not: does not
+    NOT: does NOT
+  IgnoredWords:
+    - only
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+
+RSpec/DescribedClass:
+  Exclude:
+
+RSpec/NotToNot:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,55 @@
+require: rubocop-rspec
+
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-08-25 16:34:38 -0700 using RuboCop version 0.42.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 116
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Enabled: false
+
+# Offense count: 40
+RSpec/LeadingSubject:
+  Enabled: false
+
+# Offense count: 15
+RSpec/LetSetup:
+  Exclude:
+    - 'spec/integration/collection_association_spec.rb'
+    - 'spec/integration/delete_all_spec.rb'
+    - 'spec/integration/has_many_associations_spec.rb'
+    - 'spec/integration/nested_attribute_spec.rb'
+    - 'spec/integration/persistence_spec.rb'
+    - 'spec/unit/has_and_belongs_to_many_association_spec.rb'
+
+# Offense count: 1
+RSpec/MessageChain:
+  Exclude:
+    - 'spec/unit/file_spec.rb'
+
+# Offense count: 218
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: allow, expect
+RSpec/MessageExpectation:
+  Enabled: false
+
+# Offense count: 238
+RSpec/MultipleExpectations:
+  Max: 8
+
+# Offense count: 394
+# Configuration parameters: MaxNesting.
+RSpec/NestedGroups:
+  Enabled: false
+
+# Offense count: 94
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm: 2.4.0
+matrix:
+  include:
+    - rvm: 2.3.3
+      env: "RAILS_VERSION=4.2.7.1"
+    - env: "RSOLR_VERSION=2.0.0.pre1"
+global_env:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+before_install:
+  - gem update --system
+before_script:
+  - jdk_switcher use oraclejdk8

data/CONTRIBUTING.md

@@ -0,0 +1,113 @@
+# How to Contribute
+
+We want your help to make Project Hydra great.
+There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
+
+## Hydra Project Intellectual Property Licensing and Ownership
+
+All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Hydra Project Steering Group.
+If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file.
+
+https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
+
+You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
+
+## Contribution Tasks
+
+* Reporting Issues
+* Making Changes
+* Submitting Changes
+* Merging Changes
+
+### Reporting Issues
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a [Github issue](./issues) by:
+  * Clearly describing the issue
+    * Provide a descriptive summary
+    * Explain the expected behavior
+    * Explain the actual behavior
+    * Provide steps to reproduce the actual behavior
+
+### Making Changes
+
+* Fork the repository on GitHub
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
+  * Then checkout the new branch with `git checkout fix/master/my_contribution`.
+  * Please avoid working directly on the `master` branch.
+  * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
+* Make commits of logical units.
+  * Your commit should include a high level description of your work in HISTORY.textile 
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
+
+```
+    Present tense short summary (50 characters or less)
+
+    More detailed description, if necessary. It should be wrapped to 72
+    characters. Try to be as descriptive as you can, even if you think that
+    the commit content is obvious, it may not be obvious to others. You
+    should add such description also if it's already present in bug tracker,
+    it should not be necessary to visit a webpage to check the history.
+
+    Include Closes #<issue-number> when relavent.
+
+    Description can have multiple paragraphs and you can use code examples
+    inside, just indent it with 4 spaces:
+
+        class PostsController
+          def index
+            respond_with Post.limit(10)
+          end
+        end
+
+    You can also add bullet points:
+
+    - you can use dashes or asterisks
+
+    - also, try to indent next line of a point for readability, if it's too
+      long to fit in 72 characters
+```
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+* When you are ready to submit a pull request
+
+### Submitting Changes
+
+[Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
+
+* Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
+* Make sure your branch is up to date with its parent branch (i.e. master)
+  * `git checkout master`
+  * `git pull --rebase`
+  * `git checkout <your-branch>`
+  * `git rebase master`
+  * It is likely a good idea to run your tests again.
+* Squash the commits for your branch into one commit
+  * `git rebase --interactive HEAD~<number-of-commits>` ([See Github help](https://help.github.com/articles/interactive-rebase))
+  * To determine the number of commits on your branch: `git log master..<your-branch> --oneline | wc -l`
+  * Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request from your fork to the project.
+
+### Merging Changes
+
+* It is considered "poor from" to merge your own request.
+* Please take the time to review the changes and get a sense of what is being changed. Things to consider:
+  * Does the commit message explain what is going on?
+  * Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
+  * Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
+  * Did the Travis tests complete successfully?
+* If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username.
+* If you like the pull request, but want others to chime in, create a +1 comment and tag a user.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
+* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec
+gem 'pry-byebug' unless ENV['CI']

data/LICENSE

@@ -0,0 +1,12 @@
+# Copyright 2017, The Trustees of Indiana University and Northwestern
+#   University.  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,100 @@
+Code: [![Version](https://badge.fury.io/rb/speedy_af.png)](http://badge.fury.io/rb/speedy_af)
+[![Build Status](https://travis-ci.org/samvera-labs/speedy_af.png?branch=master)](https://travis-ci.org/samvera-labs/speedy_af)
+[![Coverage Status](https://coveralls.io/repos/github/samvera-labs/speedy_af/badge.svg?branch=master)](https://coveralls.io/github/samvera-labs/speedy_af?branch=master)
+[![Code Climate](https://codeclimate.com/github/samvera-labs/speedy_af/badges/gpa.svg)](https://codeclimate.com/github/samvera-labs/speedy_af)
+[![Dependency Status](https://gemnasium.com/samvera-labs/speedy_af.png)](https://gemnasium.com/samvera-labs/speedy_af)
+
+Docs: [![Documentation Status](https://inch-ci.org/github/samvera-labs/speedy_af.svg?branch=master)](https://inch-ci.org/github/samvera-labs/speedy_af)
+[![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/speedy_af)
+[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+
+# SpeedyAF
+
+This gem provides two mixins and a presenter designed to speed up ActiveFedora-based discovery and
+display operations.
+
+**This gem depends only upon ActiveFedora, not on Hydra or HydraHead**
+
+# Table of Contents
+
+  * [Classes and Mixins](#classes-and-mixins)
+  * [Installation](#installation)
+  * [Help](#help)
+  * [Known Issues](#known-issues)
+  * [Acknowledgments](#acknowledgments)
+
+## Classes and Mixins
+
+### OrderedAggregationIndex
+
+This mixin adds an `indexed_ordered_aggregation(name)` class method that, in turn, adds two methods
+to the including class.
+
+```ruby
+class Container < ActiveFedora::Base
+  include ActiveFedora::Associations
+  include SpeedyAF::OrderedAggregationIndex
+
+  ordered_aggregation :items, class_name: 'Item', through: :list_source
+  indexed_ordered_aggregation :items
+end
+```
+
+In the example above, those two methods are `indexed_ordered_items` and `indexed_ordered_item_ids`. They
+return the same data as the standard `ordered_items` and `ordered_item_ids`, respectively, but rely more
+on Solr and less on the Fedora repository. The `_items` variant returns a lazy enumerator that yields
+target objects instead of an `ActiveFedora::Orders::TargetProxy`, but the effect is similar.
+
+### IndexedContent
+
+When mixed into an `ActiveFedora::File` descendant, it will index the resource's full content to Solr
+on save. This allows the [`Base`](#Base) to load it up without hitting Fedora.
+
+### Base
+
+`SpeedyAF::Base` is designed to load everything it can about an ActiveFedora object from Solr,
+transparently lazy-loading and delegating calls to the underlying Fedora object only when necessary.
+It casts indexed attributes to their correct types, loads both indexed and unindexed subresources
+(See [`IndexedContent`](#indexedcontent)), and responds to most reflection accessors with another
+`Base` instance containing proxies for the desired objects.
+
+A presenter (or array of presenters) can be instantiated by calling:
+
+`SpeedyAF::Base.find(item_pid)`
+or
+`SpeedyAF::Base.where(solr_query)`
+
+See the spec tests for details.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'speedy_af'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself via:
+
+    $ gem install speedy_af
+
+# Help
+
+If you have questions or need help, please email [the Hydra community tech list](mailto:hydra-tech@googlegroups.com) or stop by the #dev channel in [the Hydra community Slack team](https://wiki.duraspace.org/pages/viewpage.action?pageId=43910187#Getintouch!-Slack): [![Slack Status](http://slack.projecthydra.org/badge.svg)](http://slack.projecthydra.org/)
+
+# Known Issues
+
+* `Base` currently tries to grab all relevant rows from Solr at once. Future releases will
+  be more mindful of both local resources and Solr request limits.
+* `Base` may not play nicely with language-tagged RDF literals, as ActiveFedora does not
+  currently index/encode the language tag into Solr.
+
+# Acknowledgments
+
+This software has been developed by and is brought to you by the Hydra community.  Learn more at the
+[Project Hydra website](http://projecthydra.org/).
+
+![Project Hydra Logo](http://sufia.io/assets/images/hydra_logo.png)