samvera-nesting_indexer 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfb903c39e5837da3ce7162d2f16066b23b92127
-  data.tar.gz: 250a0310e9b7564e37e2e1ff7ac33b438fc83461
+  metadata.gz: cda0810a46d78a31bbf3dfe29b0bc43f184657c0
+  data.tar.gz: c0d79f4628040a28de9735b358223d6a648759cf
 SHA512:
-  metadata.gz: 884293f1ed28ee9df34329d6799cab60fb7c356a914d04221814aa88b5e83ebd89a6f76d6076a5278c4547c93ecb88b9ddc50a52a14930c0e253d8be46ffa943
-  data.tar.gz: a53e33bec810987ea4d286d4e626e44aa6be24d72271a1c83994c149d47269c7751443e32ea80c62e2a281a3791f55ebc38052fbba409df34dc8a991bc7ead5c
+  metadata.gz: 3aceaba25afffb5c2f7776e7d0df1f6fc6bcd7de1b23b6acad1cbd2413f0f0decb7192b8cc15fc0e0e1c264bf8c9e3b2429544ce5f60aaaa162608f1d6df992c
+  data.tar.gz: 66ae2cdd1470fef272535138656a672c625de02419a992bee823fb7342a5ecdd97c421f7a585167023c5881afb569c9f4a574917a296f5ba009cdf5e73e04d0b

data/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,36 @@
+The Samvera community is dedicated to providing a welcoming and
+positive experience for all its members, whether they are at a formal
+gathering, in a social setting, or taking part in activities online.
+The Samvera community welcomes participation from people all over the
+world and these members bring with them a wide variety of
+professional, personal and social backgrounds; whatever these may be,
+we treat colleagues with dignity and respect.
+
+Community members communicate primarily in English, though for many of
+them this is not their native language. We therefore strive to express
+ourselves simply and clearly remembering that unnecessary use of
+jargon and slang will be a barrier to understanding for many of our
+colleagues.  We are sensitive to the fact that the international
+nature of the community means that we span many different social norms
+around language and behaviour and we strive to conduct ourselves,
+online and in person, in ways that are unlikely to cause offence.
+
+Samvera conversations are often information-rich and intended to
+generate discussion and debate.  We discuss ideas from a standpoint of
+mutual respect and reasoned argument.
+
+Community members work together to promote a respectful and safe
+community. In the event that someone’s conduct is causing offence or
+distress, Samvera has a detailed
+[Anti-Harassment Policy and Protocol](https://wiki.duraspace.org/display/hydra/Anti-Harassment+Policy)
+which can be applied to address the problem. The first step in dealing
+with any serious misconduct is to contact a local meeting organizer,
+the
+[Samvera community helpers](https://wiki.duraspace.org/display/hydra/Hydra+Community+Helpers)
+([email](mailto:helpers@projecthydra.org)), a community member you
+trust, or the
+[Samvera Steering Group](https://wiki.duraspace.org/display/hydra/Samvera+Steering+Group+membership)
+immediately; at Samvera events, these people can be identified by
+distinctive name badges. The
+[Policy and Protocol](https://wiki.duraspace.org/display/hydra/Anti-Harassment+Policy)
+should be consulted for fuller details.

data/.github/CONTRIBUTING.md

@@ -0,0 +1,169 @@
+# How to Contribute
+
+We want your help to make Samvera 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.
+
+## Code of Conduct
+
+The Samvera Community is dedicated to providing a welcoming and positive
+experience for all its members, whether they are at a formal gathering, in
+a social setting, or taking part in activities online. Please see our
+[Code of Conduct](CODE_OF_CONDUCT.md) for more information.
+
+## Samvera Community Intellectual Property Licensing and Ownership
+
+All code contributors must have an Individual Contributor License Agreement
+(iCLA) on file with the Samvera 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
+* Documenting Code
+* Committing Changes
+* Submitting Changes
+* Reviewing and 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 sure you have added sufficient tests and documentation for your changes.
+  * Test functionality with RSpec; Test features / UI with Capybara.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+### Documenting Code
+
+* All new public methods, modules, and classes should include inline documentation in [YARD](http://yardoc.org/).
+  * Documentation should seek to answer the question "why does this code exist?"
+* Document private / protected methods as desired.
+* If you are working in a file with no prior documentation, do try to document as you gain understanding of the code.
+  * If you don't know exactly what a bit of code does, it is extra likely that it needs to be documented. Take a stab at it and ask for feedback in your pull request. You can use the 'blame' button on GitHub to identify the original developer of the code and @mention them in your comment.
+  * This work greatly increases the usability of the code base and supports the on-ramping of new committers.
+  * We will all be understanding of one another's time constraints in this area.
+* YARD examples:
+  * [Hydra::Works::RemoveGenericFile](https://github.com/projecthydra-labs/hydra-works/blob/master/lib/hydra/works/services/generic_work/remove_generic_file.rb)
+  * [ActiveTriples::LocalName::Minter](https://github.com/ActiveTriples/active_triples-local_name/blob/master/lib/active_triples/local_name/minter.rb)
+* [Getting started with YARD](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)
+
+### Committing changes
+
+* 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_to do |wants|
+              wants.html { render 'index' }
+            end
+          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 a good idea to run your tests again.
+* If you've made more than one commit take a moment to consider whether squashing commits together would help improve their logical grouping.
+  * [Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
+  * `git rebase --interactive master` ([See Github help](https://help.github.com/articles/interactive-rebase))
+  * 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.
+
+### Reviewing and Merging Changes
+
+We adopted [Github's Pull Request Review](https://help.github.com/articles/about-pull-request-reviews/) for our repositories.
+Common checks that may occur in our repositories:
+
+1. Travis CI - where our automated tests are running
+2. Hound CI - where we check for style violations
+3. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
+4. CodeClimate - is our code remaining healthy (at least according to static code analysis)
+
+If one or more of the required checks failed (or are incomplete), the code should not be merged (and the UI will not allow it). If all of the checks have passed, then anyone on the project (including the pull request submitter) may merge the code.
+
+*Example: Carolyn submits a pull request, Justin reviews the pull request and approves. However, Justin is still waiting on other checks (Travis CI is usually the culprit), so he does not merge the pull request. Eventually, all of the checks pass. At this point, Carolyn or anyone else may merge the pull request.*
+
+#### Things to Consider When Reviewing
+
+First, the person contributing the code is putting themselves out there. Be mindful of what you say in a review.
+
+* Ask clarifying questions
+* State your understanding and expectations
+* Provide example code or alternate solutions, and explain why
+
+This is your chance for a mentoring moment of another developer. Take time to give an honest and thorough review of what has 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_
+  * Do new or changed methods, modules, and classes have documentation?
+  * Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
+  * Does the description of the new/changed specs match your understanding of what the spec is doing?
+  * Did the Travis tests complete successfully?
+
+If you are uncertain, bring other contributors into the conversation by assigning them as a reviewer.
+
+# 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/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,20 @@
+### Descriptive summary
+
+Include what version of Hyrax relates to this issue (7.x, 6.x, HEAD, etc.) if appropriate, and any relevant tracebacks if you're reporting a bug.
+
+### Rationale
+
+Provide the rationale or user story that describes "why" this issue should be addressed. Especially if this is a new feature or significant change to the existing implementation.
+
+### Expected behavior
+
+### Actual behavior
+
+### Steps to reproduce the behavior
+
+1. Do this
+1. Then do this...
+
+### Related work
+
+Link to related tickets or prior related work here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+Present tense short summary (50 characters or less)
+
+Fixes #issuenumber ; refs #issuenumber
+
+More detailed description, if necessary. Try to be as descriptive as
+you can: even if you think that the PR content is obvious, it may not
+be obvious to others. Include tracebacks if helpful, and be sure to
+call out any bits of the PR that may be work-in-progress.
+
+Description can have multiple paragraphs and you can use code examples
+inside:
+
+``` ruby
+class PostsController
+  def index
+    respond_with Post.limit(10)
+  end
+end
+```
+
+Changes proposed in this pull request:
+*
+*
+*
+
+@samvera/hyrax-code-reviewers

data/.github/SUPPORT.md

@@ -0,0 +1,3 @@
+If you would like to report an issue with Hyrax, first do search [the list of issues](https://github.com/samvera/samvera-nesting_indexer/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera/samvera-nesting_indexer/issues/new).
+
+If you have questions or need help, please email [the Samvera community tech list](mailto:samvera-tech@googlegroups.com) or stop by the #dev channel in [the Samvera community Slack team](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391#Getintouch!-Slack).

data/.rubocop.yml

@@ -22,6 +22,7 @@ AllCops:
     - 'bin/**/*'
     - Gemfile
     - Guardfile
+    - '**/templates/**/*'
     - samvera-nesting_indexer.gemspec
   TargetRubyVersion: 2.2
 LineLength:

data/LICENSE

@@ -1,14 +1,203 @@
-##########################################################################
-# Copyright 2014-2015 University of Notre Dame
-#
-# 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.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014-2017 University of Notre Dame
+   Additional copyright may be held by others, as reflected in the commit log
+
+
+   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

@@ -6,17 +6,19 @@
 [![Documentation Status](http://inch-ci.org/github/samvera-labs/samvera-nesting_indexer.svg?branch=master)](http://inch-ci.org/github/samvera-labs/samvera-nesting_indexer)
 [![APACHE 2 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
 
-The Samvera::NestingIndexer gem is responsible for indexing the graph relationship of objects. It maps a PreservationDocument to an IndexDocument by mapping a PreservationDocument's direct parents into the paths to get from a root document to the given PreservationDocument.
+The Samvera::NestingIndexer gem generates the graph related attributes related to querying lineage of objects. It maps a PreservationDocument (e.g. a Fedora object) to an IndexDocument (e.g. a SOLR document) by mapping a PreservationDocument's direct parents to ancestral paths for the given PreservationDocument.
 
 * [Background](#background)
 * [Concepts](#concepts)
 * [Examples](#examples)
 * [Adapters](#adapters)
 * [Considerations](#considerations)
+* [Public API for Semantic Versioning](#public_api_for_semantic_versioning)
+* [Installation](#installation)
 
 ## Background
 
-This is a sandbox to work through the reindexing strategy as it relates to [CurateND Collections](https://github.com/ndlib/samvera_nd/issues/420). At this point the code is separate to allow for raid testing and prototyping (no sense spinning up SOLR and Fedora to walk an arbitrary graph).
+This gem began as a sandbox to work through the reindexing strategy for [CurateND Collections](https://github.com/ndlib/curate_nd/issues/420). This gem separates the logic of walking a graph, building the attributes necessary for nested collection maintenance, and persistence concerns. In other words, testing this gem does not require spinning up expensive persistence layers (e.g. SOLR, Fedora, or even an RDBMS).
 
 ### Notation
 
@@ -24,25 +26,25 @@ When B is a member of A, I am using the `A ={ B` notation. When C is a member of
 
 ## Concepts
 
-As we are indexing objects, we have two types of documents:
+While indexing objects, we work with two types of documents:
 
 1. [PreservationDocument](./lib/samvera/nesting_indexer/documents.rb) - a light-weight representation of a Fedora object
 2. [IndexDocument](./lib/samvera/nesting_indexer/documents.rb) - a light-weight representation of a SOLR document object
 
-We have four attributes to consider for indexing the graph:
+The four attributes to consider for indexing the graph:
 
 1. id - the unique identifier for a document
-2. parent_ids - the ids for all of the parents of a given document
+2. parent_ids - the ids for of the parents of the given document
 3. pathnames - the paths to traverse from a root document to the given document
-4. ancestors - the pathnames to each node that is an ancestor of the given node (e.g. pathname to my parent, pathname to my grandparent)
+4. ancestors - the pathnames to each ancestral node of the given node (e.g. pathname to my parent, pathname to my grandparent)
 
 See [Samvera::NestingIndexer::Documents::IndexDocument](./lib/samvera/nesting_indexer/documents.rb) for further discussion.
 
-To reindex a single document, we leverage the [`Samvera::NestingIndexer.reindex_relationships`](./lib/samvera/nesting_indexer.rb) method.
+To reindex a single document, use the [`Samvera::NestingIndexer.reindex_relationships`](./lib/samvera/nesting_indexer.rb) method.
 
-To reindex all of the documents, we leverage the [`Samvera::NestingIndexer.reindex_all!`](lib/samvera/nesting_indexer.rb) method. **Warning: This is a very slow process.**
+To reindex all documents, use the [`Samvera::NestingIndexer.reindex_all!`](lib/samvera/nesting_indexer.rb) method. **Warning: This is a very slow process.**
 
-With a node's pathname(s), we are able to query what are all of my descendants (both direct and indirect) by way of the ancestors.
+From a node's pathname(s), you can query all of that node's descendants (both direct and indirect).
 
 ## Examples
 
@@ -57,7 +59,7 @@ Given the following PreservationDocuments:
 | E   | C       |
 | F   | D       |
 
-If we were to reindex the above PreservationDocuments, we will generate the following IndexDocuments:
+When we reindex the above PreservationDocuments, then we will get the following IndexDocuments:
 
 | PID | Parents | Pathnames      | Ancestors        |
 |-----|---------|----------------|------------------|
@@ -97,6 +99,7 @@ To best ensure you have implemented the adapter to spec:
 require 'samvera/nesting_indexer/adapters/interface_behavior_spec'
 RSpec.describe MyCustomAdapter
   it_behaves_like 'a Samvera::NestingIndexer::Adapter'
+  # Your implementation details here
 end
 ```
 
@@ -139,10 +142,36 @@ Given an up to date index and a document, then it is valid to nest the given doc
 
 For examples of determining if we can nest a document within another document, see the [demonstration of nesting](./spec/features/demonstrating_nesting_spec.rb).
 
-In implementations, you'll likely want to write a queries that answer:
+In implementations, you'll likely want to write queries that answer:
 
-* What are the valid IDs that I can nest within?
-* What are the valid IDs in which I can nest within and am not already nested within?
+* Find the valid IDs that I can nest within?
+* Find the valid IDs in which I can nest within and am not already nested within?
+
+## Public API for Semantic Versioning
+
+Any method with `@api public` documentation is part of the semantically versioned API. This means you can assume:
+
+* the method will exist with the same effective signature (perhaps with changes to defaults)
+* the method can be called by upstream consumers
+* deprecations will be announced prior to major version upgrades
+
+Any module or class with `@api public` documentation is part of the semantically versioned API. This means you can assume:
+
+* the module or class can be accessed upstream
+* all public methods are assumed to be `@api public` unless otherwise stated
+* deprecations will be announced prior to major version upgrades
+
+## Installation
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'samvera-nesting_indexer'
+```
+
+Bundle up your gems (e.g. `bundle`).
+
+Then run `rails generator install samvera:nesting_indexer:install`.
 
 ## TODO
 
@@ -150,3 +179,4 @@ In implementations, you'll likely want to write a queries that answer:
 - [ ] Build methods to allow for fanning out the reindexing. At present, when we reindex a node and its "children", we run that entire process within a single context. Likewise, we run a single process when reindexing EVERYTHING.
 - [ ] Promote from [samvera-labs](https://github.com/samvera-labs) to [samvera](https://github.com/samvera) via the [promotion process](http://samvera-labs.github.io/promotion.html).
 - [ ] Write adapter method to assist in guarding against self-ancestry. We could probably expose a base adapter that has the method through use of the other adapter methods.
+- [ ] Add templates to generate the configuration

data/lib/generators/samvera/nesting_indexer/install_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Samvera
+  module NestingIndexer
+    module Generators
+      # Responsible for exposing the install generator (e.g. rails generator install amvera:nesting_indexer:install)
+      class InstallGenerator < Rails::Generators::Base
+        DEFAULT_MAXIMUM_NESTING_DEPTH = 5
+        source_root File.expand_path("../templates", __FILE__)
+        desc "Creates a Samvera::NestingIndexer initializer."
+        class_option(
+          :adapter,
+          aliases: '-a',
+          desc: "The class name of your adapter that implements the Samvera::NestingIndexer::Adapter interface",
+          required: false,
+          type: :string
+        )
+        class_option(
+          :depth,
+          aliases: '-d',
+          default: DEFAULT_MAXIMUM_NESTING_DEPTH,
+          desc: "The maximum nesting depth of documents",
+          required: false,
+          type: :numeric
+        )
+
+        def copy_initializer
+          @adapter_class_name = options.key?(:adapter) ? options[:adapter].classify : ''
+          @maximum_nesting_depth = options.fetch(:depth).to_i
+          template "samvera-nesting_indexer_initializer.rb", "config/initializers/samvera-nesting_indexer_initializer.rb"
+        end
+
+        def show_readme
+          readme "README" if behavior == :invoke
+        end
+      end
+    end
+  end
+end

data/lib/generators/samvera/nesting_indexer/templates/README

@@ -0,0 +1,15 @@
+===============================================================================
+
+Some setup you may need to complete:
+
+  1. Review the initializer and configurations installed in
+     config/initializers/samvera-nesting_indexer_initializer.rb:
+
+     a. adapter
+     b. maximum_nesting_depth
+     c. field names in the solr document
+
+  2. Ensure the defined adapter implements the Samvera::NestingIndexer::Adapter
+     (see ./lib/samvera/nesting_indexer/adapters/interface_behavior_spec.rb)
+
+===============================================================================

data/lib/generators/samvera/nesting_indexer/templates/samvera-nesting_indexer_initializer.rb

@@ -0,0 +1,24 @@
+# rubocop:disable Style/FileName
+require 'samvera/nesting_indexer'
+# rubocop:enable Style/FileName
+
+Samvera::NestingIndexer.configure do |config|
+  # How many layers of nesting are allowed for collections
+  # Given a maximum_nesting_depth of 3 the following will raise an exception:
+  # C1 ={ C2 ={ C3 ={ C4
+  # (e.g. C4 is a member of C3 is a member of C2 is a member of C1)
+  config.maximum_nesting_depth = <%= @maximum_nesting_depth %>
+
+  # The adapter that implements the Samvera::NestingIndexer::Adapter interface
+  <%- if @adapter_class_name.blank? -%>
+  # config.adapter = Hyrax::Adapters::NestingIndexAdapter
+  <%- else -%>
+  config.adapter = <%= @adapter_class_name %>
+  <%- end -%>
+
+  # The field names of the index layer attributes; These are not used by Samvera::NestingIndexer but
+  # are certainly useful as part of implementing a Samvera::NestingIndexer::Adapter interface
+  # config.solr_field_name_for_storing_parent_ids = Solrizer.solr_name('nesting_collection__parent_ids', :symbol)
+  # config.solr_field_name_for_storing_ancestors =  Solrizer.solr_name('nesting_collection__ancestors', :symbol)
+  # config.solr_field_name_for_storing_pathnames =  Solrizer.solr_name('nesting_collection__pathnames', :symbol)
+end

data/lib/samvera/nesting_indexer.rb

@@ -6,7 +6,10 @@ require 'samvera/nesting_indexer/documents'
 require 'samvera/nesting_indexer/railtie' if defined?(Rails)
 
 module Samvera
-  # Responsible for indexing an object and its related child objects.
+  # @api public
+  #
+  # A container module responsible for exposing public API methods for nested indexing and the
+  # underlying configuration to perform that indexing.
   module NestingIndexer
     # @api public
     # Responsible for reindexing the associated document for the given :id and the descendants of that :id.
@@ -86,5 +89,9 @@ module Samvera
       @configuration_block.call(configuration)
       @configuration_block = nil
     end
+
+    def self.semantic_version_messages
+      SemverAssistant.messages
+    end
   end
 end

data/lib/samvera/nesting_indexer/adapters/in_memory_adapter.rb

@@ -9,11 +9,13 @@ module Samvera
       # Defines the interface for interacting with the InMemory layer. It is a reference
       # implementation that is used throughout tests.
       module InMemoryAdapter
+        SemverAssistant.removing_from_public_api(context: self, as_of: '2.0.0')
         extend AbstractAdapter
         # @api public
         # @param id [String]
         # @return Samvera::NestingIndexer::Document::PreservationDocument
         def self.find_preservation_document_by(id:)
+          SemverAssistant.removing_from_public_api(context: "#{self.class}##{__method__}", as_of: '2.0.0')
           Preservation.find(id)
         end
 
@@ -21,6 +23,7 @@ module Samvera
         # @param id [String]
         # @return [Samvera::NestingIndexer::Documents::IndexDocument]
         def self.find_index_document_by(id:)
+          SemverAssistant.removing_from_public_api(context: "#{self.class}##{__method__}", as_of: '2.0.0')
           Index.find(id)
         end
 
@@ -28,6 +31,7 @@ module Samvera
         # @yieldparam id [String] The `id` of the preservation document
         # @yieldparam parent_ids [String] The ids of the parent objects of this presevation document
         def self.each_perservation_document_id_and_parent_ids(&block)
+          SemverAssistant.removing_from_public_api(context: "#{self.class}##{__method__}", as_of: '2.0.0')
           Preservation.find_each do |document|
             block.call(document.id, document.parent_ids)
           end
@@ -41,6 +45,7 @@ module Samvera
         # @param document [Samvera::NestingIndexer::Documents::IndexDocument]
         # @yield [Samvera::NestingIndexer::Documents::IndexDocument]
         def self.each_child_document_of(document:, &block)
+          SemverAssistant.removing_from_public_api(context: "#{self.class}##{__method__}", as_of: '2.0.0')
           Index.each_child_document_of(document: document, &block)
         end
 
@@ -50,6 +55,7 @@ module Samvera
         # @param attributes [Hash]
         # @return [Samvera::NestingIndexer::Documents::PreservationDocument]
         def self.write_document_attributes_to_preservation_layer(attributes)
+          SemverAssistant.removing_from_public_api(context: "#{self.class}##{__method__}", as_of: '2.0.0')
           Preservation.write_document(attributes)
         end
 
@@ -62,6 +68,7 @@ module Samvera
         # @param deepest_nested_depth [Integer]
         # @return [Hash] - the attributes written to the indexing layer
         def self.write_document_attributes_to_index_layer(id:, parent_ids:, ancestors:, pathnames:, deepest_nested_depth:)
+          SemverAssistant.removing_from_public_api(context: "#{self.class}##{__method__}", as_of: '2.0.0')
           Index.write_document(id: id, parent_ids: parent_ids, ancestors: ancestors, pathnames: pathnames, deepest_nested_depth: deepest_nested_depth)
         end
 
@@ -69,6 +76,7 @@ module Samvera
         # @see README.md
         # @param nesting_document [Samvera::NestingIndexer::Documents::IndexDocument]
         def self.write_nesting_document_to_index_layer(nesting_document:)
+          SemverAssistant.removing_from_public_api(context: "#{self.class}##{__method__}", as_of: '2.0.0')
           Index.write_to_storage(nesting_document)
         end
 

data/lib/samvera/nesting_indexer/configuration.rb

@@ -3,7 +3,6 @@ require 'samvera/nesting_indexer/exceptions'
 require 'logger'
 
 module Samvera
-  # :nodoc:
   module NestingIndexer
     # @api public
     # Responsible for the configuration of the Samvera::NestingIndexer
@@ -81,6 +80,6 @@ module Samvera
         end
       end
     end
-    private_constant :Configuration
   end
 end
+Samvera::NestingIndexer.private_constant :Configuration

data/lib/samvera/nesting_indexer/documents.rb

@@ -1,7 +1,9 @@
 require 'dry-equalizer'
+require 'samvera/nesting_indexer/semver_assistant'
 
 module Samvera
   module NestingIndexer
+    # @api public
     module Documents
       ANCESTOR_AND_PATHNAME_DELIMITER = '/'.freeze
 
@@ -14,10 +16,12 @@ module Samvera
           @id = keywords.fetch(:id).to_s
           @parent_ids = Array(keywords.fetch(:parent_ids))
         end
+        SemverAssistant.removing_from_public_api(context: self, as_of: '2.0.0')
 
         # @api public
         # @return String The Fedora object's PID
         attr_reader :id
+        SemverAssistant.removing_from_public_api(context: "#{self}#id", as_of: '2.0.0')
 
         # @api public
         #
@@ -26,6 +30,7 @@ module Samvera
         # This does not include grandparents, great-grandparents, etc.
         # @return Array<String>
         attr_reader :parent_ids
+        SemverAssistant.removing_from_public_api(context: "#{self}#parent_id", as_of: '2.0.0')
       end
 
       # @api public
@@ -96,18 +101,23 @@ module Samvera
         #
         # @return Integer
         def deepest_nested_depth
-          pathnames.map(&:length).max
+          pathnames.map do |pathname|
+            pathname.split(ANCESTOR_AND_PATHNAME_DELIMITER).count
+          end.max
         end
 
         def sorted_parent_ids
+          SemverAssistant.removing_from_public_api(context: "#{self.class}##{__method__}", as_of: '2.0.0')
           parent_ids.sort
         end
 
         def sorted_pathnames
+          SemverAssistant.removing_from_public_api(context: "#{self.class}##{__method__}", as_of: '2.0.0')
           pathnames.sort
         end
 
         def sorted_ancestors
+          SemverAssistant.removing_from_public_api(context: "#{self.class}##{__method__}", as_of: '2.0.0')
           ancestors.sort
         end
       end

data/lib/samvera/nesting_indexer/relationship_reindexer.rb

@@ -3,7 +3,6 @@ require 'forwardable'
 require 'set'
 
 module Samvera
-  # Establishing namespace
   module NestingIndexer
     # Responsible for reindexing the document associated with the given PID and its descendant documents
     # @note There is cycle detection via the Samvera::NestingIndexer::Configuration#maximum_nesting_depth counter
@@ -153,6 +152,6 @@ module Samvera
       end
       private_constant :ParentAndPathAndAncestorsBuilder
     end
-    private_constant :RelationshipReindexer
   end
 end
+Samvera::NestingIndexer.private_constant :RelationshipReindexer

data/lib/samvera/nesting_indexer/repository_reindexer.rb

@@ -1,7 +1,6 @@
 require 'samvera/nesting_indexer/exceptions'
 require 'forwardable'
 module Samvera
-  # Establishing namespace
   module NestingIndexer
     # Responsible for reindexing the entire repository
     # @api private
@@ -70,6 +69,6 @@ module Samvera
         raise Exceptions::ReindexingError.new(id, e)
       end
     end
-    private_constant :RepositoryReindexer
   end
 end
+Samvera::NestingIndexer.private_constant :RepositoryReindexer

data/lib/samvera/nesting_indexer/semver_assistant.rb

@@ -0,0 +1,19 @@
+require 'set'
+module Samvera
+  module NestingIndexer
+    # @api private
+    # A service object responsible for coordinating declarations of interface changes
+    module SemverAssistant
+      def self.messages
+        @messages ||= Set.new
+      end
+
+      def self.removing_from_public_api(context:, as_of:)
+        message = "As of version #{as_of}, #{context} will be removed from the public API"
+        messages << message
+        ActiveSupport::Deprecation.warn(message, caller[1..-1]) if defined?(ActiveSupport::Deprecation) && !ENV.key?('SKIP_ACTIVE_SUPPORT_DEPRECATION')
+      end
+    end
+  end
+end
+Samvera::NestingIndexer.private_constant :SemverAssistant

data/lib/samvera/nesting_indexer/version.rb

@@ -1,5 +1,5 @@
 module Samvera
   module NestingIndexer
-    VERSION = "1.0.0".freeze
+    VERSION = "1.0.1".freeze
   end
 end

data/samvera-nesting_indexer.gemspec

@@ -20,20 +20,19 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~>2.0'
 
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "guard-rubocop"
-  spec.add_development_dependency "terminal-notifier-guard"
-  spec.add_development_dependency "terminal-notifier"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "json"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "railties"
-  # As a secondary dependency, listen is preventing bundling
   spec.add_development_dependency "listen", '~> 3.0.8'
+  spec.add_development_dependency "railties"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "terminal-notifier-guard"
+  spec.add_development_dependency "terminal-notifier"
   spec.add_dependency "dry-equalizer"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samvera-nesting_indexer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,35 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rubocop
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,21 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: terminal-notifier-guard
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.8
 - !ruby/object:Gem::Dependency
-  name: terminal-notifier
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,21 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,21 +151,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,19 +207,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: terminal-notifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.8
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.8
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
   requirement: !ruby/object:Gem::Requirement
@@ -241,6 +241,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/SUPPORT.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -256,6 +261,9 @@ files:
 - bin/setup
 - documentation/reindex_relationship.mermaid
 - documentation/reindex_relationship.mermaid.jpg
+- lib/generators/samvera/nesting_indexer/install_generator.rb
+- lib/generators/samvera/nesting_indexer/templates/README
+- lib/generators/samvera/nesting_indexer/templates/samvera-nesting_indexer_initializer.rb
 - lib/samvera/nesting_indexer.rb
 - lib/samvera/nesting_indexer/adapters.rb
 - lib/samvera/nesting_indexer/adapters/abstract_adapter.rb
@@ -267,6 +275,7 @@ files:
 - lib/samvera/nesting_indexer/railtie.rb
 - lib/samvera/nesting_indexer/relationship_reindexer.rb
 - lib/samvera/nesting_indexer/repository_reindexer.rb
+- lib/samvera/nesting_indexer/semver_assistant.rb
 - lib/samvera/nesting_indexer/version.rb
 - samvera-nesting_indexer.gemspec
 homepage: https://github.com/samvera-labs/samvera-nesting_indexer