om 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 47b327a1e5c5c97aaced259dfada9e0272a7e011
-  data.tar.gz: 43198216111873a28f12a414d420bccf3f1453f6
+SHA256:
+  metadata.gz: 5e35bb0e071114f2af407331f40d41433c1fc1d94c3ddcad10a44e9f2261d068
+  data.tar.gz: 46bd8fa47d67c35ec6c535e66d42a288a6abc1ef1ba71a62bfa9536aaca94e50
 SHA512:
-  metadata.gz: 509267f8bedd654a287e8c97dbd55076f6c21beb31e6af88b0910a5b33c505e2e1efff7f36ae5b831731e58fe4d9723c9e6e56da568bdc12e56f7321bb87fab5
-  data.tar.gz: 717a6650a821571adac1077be22ef1e56d4c56d74821601c3372f48caa29ce2217a1c2d47fdb9c2be2356f3c09cd3225db80037f9a36065f057f4a1ec3aa1b12
+  metadata.gz: f62a9a01aba29b15bd19ef6ed3b6784ce2c86fddce5ae589ff77ef7ae921cee5bb3fa11b9745189a11832d46cb89ec148c441133acfb5abbd8f11cc3da065f64
+  data.tar.gz: b7911b910411e415872b14fa27150872388a887ccf80c57159257fc9d0a6ad45dab1f0235d0145dc54c82e343957cc05153671648c5de52703c430f49c82322f

data/.circleci/config.yml

@@ -0,0 +1,60 @@
+---
+version: 2.1
+orbs:
+  samvera: samvera/circleci-orb@0
+jobs:
+  test:
+    parameters:
+      ruby_version:
+        type: string
+      bundler_version:
+        type: string
+        default: 1.17.3
+      rails_version:
+        type: string
+    executor:
+      name: 'samvera/ruby'
+      ruby_version: << parameters.ruby_version >>
+    environment:
+      COVERAGE: true
+      RAILS_VERSION: << parameters.rails_version >>
+      NOKOGIRI_USE_SYSTEM_LIBRARIES: true
+    steps:
+      - samvera/cached_checkout
+      - samvera/bundle_for_gem:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+          project: om
+      - samvera/parallel_rspec
+workflows:
+  version: 2
+  ci:
+    jobs:
+      - test:
+          name: ruby2-6_rails6-0
+          ruby_version: 2.6.3
+          rails_version: 6.0.0.rc2
+      - test:
+          name: ruby2-6_rails5-2
+          ruby_version: 2.6.3
+          rails_version: 5.2.3
+      - test:
+          name: ruby2-5_rails5-2
+          ruby_version: 2.5.5
+          rails_version: 5.2.3
+      - test:
+          name: ruby2-4_rails5-2
+          ruby_version: 2.4.6
+          rails_version: 5.2.3
+      - test:
+          name: ruby2-6_rails5-1
+          ruby_version: 2.6.3
+          rails_version: 5.1.7
+      - test:
+          name: ruby2-5_rails5-1
+          ruby_version: 2.5.5
+          rails_version: 5.1.7
+      - test:
+          name: ruby2-4_rails5-1
+          ruby_version: 2.4.6
+          rails_version: 5.1.7

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/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/samvera/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/samvera/Samvera+Community+Helpers)
+([email](mailto:helpers@samvera.org)), a community member you
+trust, or the
+[Samvera Steering Group](https://wiki.duraspace.org/display/samvera/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/samvera/Anti-Harassment+Policy)
+should be consulted for fuller details.

data/CONTRIBUTING.md

@@ -1,14 +1,24 @@
 # 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.
+We want your help to make the Samvera community 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
+## Code of Conduct
 
-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.
+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.
 
-https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
+## 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/samvera/Samvera+Community+Intellectual+Property+Licensing+and+Ownership
 
 You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
 
@@ -16,13 +26,15 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 
 * Reporting Issues
 * Making Changes
+* Documenting Code
+* Committing Changes
 * Submitting Changes
-* Merging 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:
+* Submit a [Github issue](https://github.com/samvera/om/issues) by:
   * Clearly describing the issue
     * Provide a descriptive summary
     * Explain the expected behavior
@@ -38,8 +50,24 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
   * 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.
+* [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.md 
 * 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)
@@ -60,7 +88,9 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 
         class PostsController
           def index
-            respond_with Post.limit(10)
+            respond_to do |wants|
+              wants.html { render 'index' }
+            end
           end
         end
 
@@ -78,36 +108,54 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 
 ### 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`
+  * 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.
 
-### Merging Changes
+### 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. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
+
+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:
 
-* It is considered "poor form" 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_
+  * 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 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.
+
+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/)
+* [GitHub pull request documentation](https://help.github.com/articles/about-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

@@ -7,3 +7,11 @@ group :development, :test do
   gem 'simplecov', :platform => :mri_19
   gem 'simplecov-rcov', :platform => :mri_19
 end
+
+if ENV['RAILS_VERSION']
+  if ENV['RAILS_VERSION'] == 'edge'
+    gem 'rails', github: 'rails/rails'
+  else
+    gem 'rails', ENV['RAILS_VERSION']
+  end
+end

data/History.md

@@ -1,3 +1,14 @@
+### 3.2.0 (14 August 2019)
+- 2019-08-14: Ensures that Rails 6.x releases are supported [@jcoyne]
+- 2019-08-02: Corrected the syntax for the CircleCI configuration [@botimer]
+- 2019-05-28: Updated CircleCI to test against Rails release 5.1.7 and Ruby releases 2.6.3, 2.5.5, and 2.4.6 [@jrgriffiniii]
+- 2019-05-08: Deprecated Travis CI for CircleCI for continuous integration testing [@jrgriffiniii]
+- 2018-09-19: Updated documentation for compliance with the Core Component Maintenance Working Group templates [@jrgriffiniii]
+- 2018-09-19: Integrated Coveralls [@jrgriffiniii]
+- 2016-10-27: Removed Travis CI notifications to IRC [@mjgiarlo]
+- 2015-05-26: Converted documentation to Markdown [@atz]
+- 2015-04-21: Convert specs to RSpec 2.99.2 syntax with Transpec [@atz]
+- 2015-03-10: Changed RSpec assertions from .should() to the newer, preferred expect().to() [@nodanaonlyzuul]
 - 2014-09-11: Use HTTPS URLs for RubyGems [Michael Slone]
 
 ### 3.1.0 (17 Jul 2014)

data/LICENSE

@@ -1,15 +1,11 @@
-##########################################################################
-# Copyright (c) 2009 Matt Zumwalt
-# 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.
+Copyright 2009 Matt Zumwalt
+Additional copyright may be held by others, as reflected in the commit history.
+ 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

@@ -1,34 +1,41 @@
-[![Build Status](https://travis-ci.org/projecthydra/om.png?branch=master)](https://travis-ci.org/projecthydra/om)
-[![Gem Version](https://badge.fury.io/rb/om.png)](http://badge.fury.io/rb/om)
-
 # om (Opinionated Metadata)
 
+[![Version](https://badge.fury.io/rb/om.png)](http://badge.fury.io/rb/om)
+[![CircleCI](https://circleci.com/gh/samvera/om.svg?style=svg)](https://circleci.com/gh/samvera/om)
+[![Coverage Status](https://coveralls.io/repos/github/samvera/om/badge.svg?branch=master)](https://coveralls.io/github/samvera/om?branch=master)
+
+Jump In: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)
+
+# What is om?
+
 A library to help you tame sprawling XML schemas like MODS.
 
 OM allows you to define a "terminology" to ease translation between XML and ruby objects – you can query the xml for Nodes or node values without ever writing a line of XPath.
 
 OM "terms" are ruby symbols you define (in the terminology) that map specific XML content into ruby object attributes.
 
+## Product Owner & Maintenance
+ **om** is a Core Component of the Samvera community. The documentation for
+what this means can be found
+[here](http://samvera.github.io/core_components.html#requirements-for-a-core-component).
+ ### Product Owner
+ [Jon Cameron](https://github.com/joncameron)
+
 ## Tutorials & Reference
 
-* [Tame Your XML with OM](https://github.com/projecthydra/om/wiki/Tame-your-XML-with-OM)
-* [Common OM Patterns](https://github.com/projecthydra/om/blob/master/COMMON_OM_PATTERNS.md)
+* [Tame Your XML with OM](https://github.com/samvera/om/wiki/Tame-your-XML-with-OM)
+* [Common OM Patterns](https://github.com/samvera/om/blob/master/COMMON_OM_PATTERNS.md)
 
 ### Solrizing Documents
 
 The solrizer gem provides support for indexing XML documents into Solr based on OM Terminologies.  
-That process is documented in the [solrizer README](https://github.com/projecthydra/solrizer)
-
-## OM in the Wild
-
-We have a page on the Hydra wiki with a list of OM Terminologies in active use: 
-[OM Terminologies in the Wild](https://wiki.duraspace.org/display/hydra/OM+Terminologies+in+the+Wild)
+That process is documented in the [solrizer README](https://github.com/samvera/solrizer)
 
 ## Acknowledgments
 
 ### Creator
 
-Matt Zumwalt ([MediaShelf](http://yourmediashelf.com))
+Matt Zumwalt (MediaShelf)
 
 ### Thanks To
 

data/SUPPORT.md

@@ -0,0 +1,5 @@
+If you would like to report an issue, first search [the list of issues](https://github.com/samvera/om/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera/om/issues/new).
+
+If you have questions or need help, please email [the Samvera community tech list](https://groups.google.com/forum/#!forum/samvera-tech) or stop by the #dev channel in [the Samvera community Slack team](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391#Getintouch!-Slack).
+
+You can learn more about the various Samvera communication channels on the [Get in touch!](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391) wiki page.

data/lib/om/version.rb

@@ -1,3 +1,3 @@
 module Om
-  VERSION = "3.1.1"
+  VERSION = "3.2.0"
 end

data/lib/om/xml/document.rb

@@ -59,7 +59,7 @@ module OM::XML::Document
       self.terminology_builder.extend_terminology(&block)
       rebuild_terminology!
     end
-    
+
     # (Explicitly) inherit terminology from upstream classes
     def use_terminology klass
       self.terminology_builder = klass.terminology_builder.dup
@@ -84,9 +84,17 @@ module OM::XML::Document
 
   attr_accessor :ox_namespaces
 
+  # This ensures that the stored XML is deleted
+  # @see ActiveModel::Dirty#attribute_will_change!
+  # @see ActiveModel::Dirty#attribute_will_change!
   def ng_xml_will_change!
     # throw away older version.
-    changed_attributes['ng_xml'] = nil
+    # This clears both @attributes_changed_by_setter and @mutations_from_database
+    clear_attribute_changes [:ng_xml]
+    # This clears the cached changes
+    @cached_changed_attributes[:ng_xml] = nil if defined? @cached_changed_attributes
+
+    attribute_will_change!(:ng_xml)
   end
 
   def ng_xml_changed?
@@ -97,12 +105,12 @@ module OM::XML::Document
     if matches = /([^=]+)=$/.match(method_name.to_s)
       name = matches[1].to_sym
     end
-    
+
     name ||= method_name
-    
+
     begin
       term = self.class.terminology.retrieve_term(name)
-      
+
       if /=$/.match(method_name.to_s)
         node = OM::XML::DynamicNode.new(name, nil, self, term)
         return node.val=args

data/lib/tasks/om.rake

@@ -1,28 +1,30 @@
+
 desc "Task to execute builds on a Hudson Continuous Integration Server."
 task :hudson do
   Rake::Task["om:doc"].invoke
   Rake::Task["coverage"].invoke
 end
 
-
 desc "Execute specs with coverage"
-task :coverage do 
+task :coverage do
   # Put spec opts in a file named .rspec in root
   ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
   ENV['COVERAGE'] = 'true' unless ruby_engine == 'jruby'
-
-
   Rake::Task['om:rspec'].invoke
 end
 
-namespace :om do    
+namespace :om do
+  begin
+    require 'rspec/core/rake_task'
 
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:rspec) do |spec|
-    if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.8/
-      spec.rcov = true
-      spec.rcov_opts = %w{-I../../app -I../../lib --exclude spec\/*,gems\/*,ruby\/* --aggregate coverage.data}
+    RSpec::Core::RakeTask.new(:rspec) do |spec|
+      if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.8/
+        spec.rcov = true
+        spec.rcov_opts = %w{-I../../app -I../../lib --exclude spec\/*,gems\/*,ruby\/* --aggregate coverage.data}
+      end
     end
+  rescue LoadError => load_error
+    abort "Failed to load RSpec: #{load_error}"
   end
 
   # Use yard to build docs
@@ -34,7 +36,6 @@ namespace :om do
 
     YARD::Rake::YardocTask.new(:doc) do |yt|
       readme_filename = 'README.md'
-      #yt.options = ['--private', '--protected', '--output-dir', doc_destination, '--readme', readme_filename]
     end
   rescue LoadError
     desc "Generate YARD Documentation"
@@ -42,9 +43,4 @@ namespace :om do
       abort "Please install the YARD gem to generate rdoc."
     end
   end
-
-
-
-
 end
-