hydra-file_characterization 0.3.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8c3e177907738ef60151151394669f403baf76e9
-  data.tar.gz: 9c76f5edba884d3a0308f493c41748827b9dc531
+SHA256:
+  metadata.gz: fc80d9f0fda674639f974b581b57939e1b7cd9b32a992b7119f90ea017c883ad
+  data.tar.gz: a4e3af95b921b20d395b3405f29b3e2bfcc3a15882265f8989338f1fcf9594ae
 SHA512:
-  metadata.gz: 84ee01ddc01e363e95d1eb253e836feb6c1666233f9d0f5cc40ed4d40c0be2e8cbc49a02a50441b5ca97ea938e848604b4729c724f889d5400031ef2e0b2edc4
-  data.tar.gz: 0c511f76ddb998a39f84971ccf180e5397d1ae042fc37370de061a97ccb231d1531978aa5593a5234958b5972ca9c06ac3af0424262321e06e8d29f59bff9c9b
+  metadata.gz: a6fd8b4b84d9a5fa5e1a9d28c6aba85611690656a7aaee7205ee0cdf30e3f797ebdfaa8952d4a226efdd15ff608f2685bf12e6133d05b3a7f6ed491f1cedad5e
+  data.tar.gz: 243e3a2d57e41f3e2cb9a71004c4a2ccc8f136115d2008390d3a66570a4c1f0e1dec4ebfb8c490f702cb99ee3b8d25d0dd7ec8febad60463d57b5783152a0f51

data/.travis.yml

@@ -6,4 +6,4 @@ env:
   global:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
 rvm:
-  - 2.2
+  - 2.4.1

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/hydra-file_characterization/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.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)
@@ -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 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_
+  * 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/LICENSE

@@ -1,16 +1,14 @@
-##########################################################################
-#
-# Copyright 2013 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.
+Copyright 2013 Notre Dame
+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,12 +1,33 @@
-# hydra-file_chracterization [![Version](https://badge.fury.io/rb/hydra-file_characterization.png)](http://badge.fury.io/rb/hydra-file_characterization) [![Build Status](https://travis-ci.org/projecthydra/hydra-file_characterization.png?branch=master)](https://travis-ci.org/projecthydra/hydra-file_characterization) [![Dependency Status](https://gemnasium.com/projecthydra/hydra-file_characterization.png)](https://gemnasium.com/projecthydra/hydra-file_characterization)
+# hydra-file_characterization
 
-Hydra::FileCharacterization as (extracted from Sufia and Hydra::Derivatives)
+Code: [![Version](https://badge.fury.io/rb/hydra-file_characterization.png)](http://badge.fury.io/rb/hydra-file_characterization)
+[![Build Status](https://travis-ci.org/samvera/hydra-file_characterization.png?branch=master)](https://travis-ci.org/samvera/hydra-file_characterization)
+[![Coverage Status](https://coveralls.io/repos/github/samvera/hydra-file_characterization/badge.svg?branch=master)](https://coveralls.io/github/samvera/hydra-file_characterization?branch=master)
 
-## Purpose
+Docs: [![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)
 
-To provide a wrapper for file characterization
+Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)
 
-## How To Use
+# What is hydra-file_characterization?
+
+Provides a wrapper for file characterization.
+
+## Product Owner & Maintenance
+
+hydra-file_characterization 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
+
+[little9](https://github.com/little9)
+
+# Help
+
+The Samvera community is here to help. Please see our [support guide](./SUPPORT.md).
+
+# Getting Started
 
 If you are using Rails add the following to an initializer (./config/initializers/hydra-file_characterization_config.rb):
 
@@ -15,10 +36,16 @@ Hydra::FileCharacterization.configure do |config|
   config.tool_path(:fits, '/path/to/fits')
 end
 ```
+```ruby
+Hydra::FileCharacterization.characterize(File.read(filename), File.basename(filename), :fits)```
+
+* Why `file.read`? To highlight that we want a string. In the case of ActiveFedora, we have a StringIO instead of a file.
+* Why `file.basename`? In the case of Fits, the characterization takes cues from the extension name.
 
 You can call a single characterizer…
+
 ```ruby
-xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits)
+xml_string = Hydra::FileCharacterization.characterize(File.read("/path/to/my/file.rb"), 'file.rb', :fits)
 ```
 
 …for this particular call, you can specify custom fits path…
@@ -51,9 +78,13 @@ You can also call multiple characterizers at the same time.
 fits_xml, ffprobe_xml = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits, :ffprobe)
 ```
 
-* Why `file.read`? To highlight that we want a string. In the case of ActiveFedora, we have a StringIO instead of a file.
-* Why `file.basename`? In the case of Fits, the characterization takes cues from the extension name.
-
 ## Registering New Characterizers
 
 This is possible by adding a characterizer to the `Hydra::FileCharacterization::Characterizers`' namespace.
+
+# Acknowledgments
+
+This software has been developed by and is brought to you by the Samvera community.  Learn more at the
+[Samvera website](http://samvera.org/).
+
+![Samvera Logo](https://wiki.duraspace.org/download/thumbnails/87459292/samvera-fall-font2-200w.png?version=1&modificationDate=1498550535816&api=v2)

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/hydra-file_characterization/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera/hydra-file_characterization/issues/new).
+i
+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/hydra-file_characterization.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "activesupport", ">= 3.0.0"
+  gem.add_development_dependency 'coveralls'
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "guard"

data/lib/hydra/file_characterization/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module FileCharacterization
-    VERSION = "0.3.3"
+    VERSION = "1.0.0"
   end
 end

data/spec/spec_helper.rb

@@ -8,6 +8,9 @@
 GEM_ROOT = File.expand_path("../../", __FILE__)
 $:.unshift File.join(GEM_ROOT, "lib")
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'hydra/file_characterization'
 
 module SpecSupport

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-file_characterization
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 1.0.0
 platform: ruby
 authors:
 - James Treacy
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,6 +27,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -96,12 +110,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- SUPPORT.md
 - hydra-file_characterization.gemspec
 - lib/hydra-file_characterization.rb
 - lib/hydra/file_characterization.rb
@@ -145,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: To provide a wrapper for file characterization
@@ -163,4 +179,3 @@ test_files:
 - spec/lib/hydra/file_characterization/to_temp_file_spec.rb
 - spec/lib/hydra/file_characterization_spec.rb
 - spec/spec_helper.rb
-has_rdoc: