hydramata-works 0.0.1.prerelease

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  - "2.1.1"
+  - "2.1.2"
+
+gemfile:
+  - gemfiles/rails4.gemfile
+  - gemfiles/rails4.1.gemfile
+
+env:
+  global:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+script: 'COVERAGE=true rake spec:travis'
+
+bundler_args: --without headless debug
+
+before_install:
+  - gem install bundler

data/CONTRIBUTING.md

@@ -0,0 +1,220 @@
+We want your help to make our project 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.
+
+* [The Hydra Way](#the-hydra-way)
+* [Reporting Issues](#reporting-issues)
+  * [What is a well written issue?](#what-is-a-well-written-issue)
+* [Making Changes](#making-changes)
+  * [Where to Engage for Help](#where-to-engage-for-help)
+* [Submitting Changes](#submitting-changes)
+  * [Contributor License Agreement](#contributor-license-agreement)
+  * [Coding Guidelines](#coding-guidelines)
+    * [Writing Your Specs](#writing-your-specs)
+      * [Custom Rspec Matchers](#custom-rspec-matchers)
+    * [Writing Your Code](#writing-your-code)
+    * [Ruby File Structure](#ruby-file-structure)
+  * [Well Written Commit Messages](#well-written-commit-messages)
+* [Reviewing Changes](#reviewing-changes)
+  * [Responsibilities of a Reviewer](#responsibilities-of-a-reviewer)
+  * [Responsibilities of the Submitter](#responsibilities-of-the-submitter)
+* [Merging Changes](#merging-changes)
+
+# The Hydra Way
+
+We strive to…
+
+* Provide a [harassment-free community experience](https://wiki.duraspace.org/display/hydra/Anti-Harassment+Policy)
+* Adhere to our [Hierarchy of Promises](https://wiki.duraspace.org/display/hydra/Hydra+Stack+-+The+Hierarchy+of+Promises)
+* Operate under [Lazy Consensus](http://rave.apache.org/docs/governance/lazyConsensus.html)
+* Encourage community participation as guided by [our community principles](https://wiki.duraspace.org/display/hydra/Hydra+Community+Principles)
+
+# Reporting Issues
+
+Submit a [well written issue](#what-is-a-well-written-issue) to [Github's issue tracker](./issues).
+This will require a [GitHub account](https://github.com/signup/free) *(its free)*.
+
+## What is a well written issue?
+
+* Provide a descriptive summary
+* Reference the gem version in which you encountered the problem
+* Explain the expected behavior
+* Explain the actual behavior
+* Provide steps to reproduce the actual behavior
+
+# Submitting Changes
+
+## Contributor License Agreement
+
+**Note: You can submit a pull request before you've signed the Contributor License Agreement, but we won't merge your changes until we have your CLA on file.**
+
+Before any [ProjectHydra project](https://github.com/projecthydra) can accept your contributions we must have a [Contributor License Agreement on file](https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership).
+
+All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Hydra Project Steering Group.
+If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file.
+
+[More on the Contributor License Agreements](https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership)
+
+## Coding Guidelines
+
+This project is using [HoundCI](https://houndci.com) to help support our agreed upon style guide.
+The style guide is a work in progress, and is declared in the project's `./hound.yml` file.
+
+Hound is a Github integration tool that essentially runs [rubocop](http://rubygems.org/gems/rubocop).
+
+> Automatic Ruby code style checking tool. Aims to enforce the community-driven Ruby Style Guide.
+
+If you want to run `rubocop` with our style guide, first `gem install rubocop` then inside the project:
+
+```bash
+$ rubocop ./path/to/file ./or/path/to/directory -c ./.hound.yml
+```
+**Can I break these guidelines?** Yes. But you may need to convince the person merging your changes.
+
+### Writing Your Specs
+
+Your code changes should include support tests.
+
+Before you begin writing code, think about the test that will verify the code you plan to write.
+A [well written story with Gherkin syntax](http://pivotallabs.com/well-formed-stories/) can help formulate the pre-conditions (Given), invocation (When), and post-conditions (Then).
+
+*This is the first step of Test Driven Development, and something that we strongly encourage.*
+
+Now write that test; It should be your guidepost for any changes you plan on making.
+Ideally the test you just wrote will be executable code.
+However, a well formed Gherkin-syntax story is a suitable proxy; Especially if you are uncomfortable with where to put the executable code.
+
+*Think of your written test as a statement of intent.*
+*The statement of intent can then be used when asking for help or clarity; Either from another developer or a stakeholder.*
+*Someone helping you can then see both what you are trying to do and how you are doing it; And that helper may know of a "better" way to do it.*
+
+#### Custom Rspec Matchers
+
+We encourage the use of [custom rspec matchers](https://www.relishapp.com/rspec/rspec-expectations/v/2-3/docs/custom-matchers/define-matcher) as this helps our specs better convey what is going on.
+
+To find the existing Rspec matchers in this project, you can run `rake yenta`.
+Below is the sample output.
+
+```shell
+be                 /path/to/bundled/gem/rspec-expectations-2.14.4/lib/rspec/matchers.rb:221
+be_a               /path/to/bundled/gem/rspec-expectations-2.14.4/lib/rspec/matchers.rb:227
+be_a_kind_of       /path/to/bundled/gem/rspec-expectations-2.14.4/lib/rspec/matchers.rb:253
+be_a_new           /path/to/bundled/gem/rspec-rails-2.14.0/lib/rspec/rails/matchers/be_a_new.rb:73
+be_an              /path/to/bundled/gem/rspec-expectations-2.14.4/lib/rspec/matchers.rb:227
+be_an_instance_of  /path/to/bundled/gem/rspec-expectations-2.14.4/lib/rspec/matchers.rb:240
+...
+```
+
+### Writing Your Code
+
+We are going to do our best to follow [Sandi Metz' Rules for Developers](http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers)
+
+> Here are the rules:
+>
+> * Classes can be no longer than one hundred lines of code.
+> * Methods can be no longer than five lines of code.
+> * Pass no more than four parameters into a method. Hash options are parameters.
+> * Controllers can instantiate only one object. Therefore, views can only know about one instance variable and views should only send messages to that object (@object.collaborator.value is not allowed).
+
+### Ruby File Structure
+
+* Use soft-tabs with a two space indent.
+* Never leave trailing whitespace (unless it is meaningful in the language)
+* End each file with a blank newline.
+* Please do your best to keep lines to 80 characters or fewer.
+
+## Well Written Commit Messages
+
+**TL;DR**
+
+* First line is < 50 characters
+* The message body explains what the code changes are about
+* Reference any JIRA or Github issues on new lines.
+
+### Terse Example
+
+```
+    Removing Document title validation
+
+    We thought we wanted title validation but that was too complicated.
+
+    HYDRASIR-12 #close
+```
+
+### Verbose Example
+
+```
+    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.
+
+    Description can have multiple paragraphs and you can use code examples
+    inside, just indent it with 4 spaces:
+
+        class PostsController
+          def index
+            respond_with Post.limit(10)
+          end
+        end
+
+    You can also add bullet points:
+
+    - you can use dashes or asterisks
+
+    - also, try to indent next line of a point for readability, if it's too
+      long to fit in 72 characters
+```
+
+> When appropriate, please squash your commits into logical units of work.
+> This simplifies future cherry picks, and also keeps the git log clean.
+
+### Hooks into other Subsystems
+
+**[log skip]**: If your commit is not relevant to a change log, you can add `[log skip]` to your commit message.
+Relevance is subjective, though extremely minor changes need not be part of the change log (i.e. spelling correction, decomposing a private method into multiple private methods, etc.)
+
+**[ci skip]**: If your commit does not need to go through the Continuous Integration server, add `[ci skip]` to your commit message.
+This is typically used for updates to the documentation and stylesheet changes.
+
+# Reviewing Changes
+
+The review process is a conversation between the submitter and the reviewer(s).
+Please feel free to bring other people into the conversation as necessary.
+
+As either the submitter or reviewer, feel free to assign the Pull Request to a repository contributor.
+This is a way of indicating that you want that repository contributor to review the change.
+
+When you do assign someone to the Pull Request, please make sure to add a comment stating why you assigned it to them.
+
+## Responsibilities of a Reviewer
+
+As a reviewer, it is important that the pull request:
+
+* Has a [well written commit message](#well-written-commit-messages)
+* Has [well written code](#coding-guidelines)
+* The test suite successfully builds
+* Any questions regarding the pull request are answered
+* Adjucate if the Pull Request should be squashed into a smaller number of commits
+
+## Responsibilities of the Submitter
+
+**As the submitter**, you should be responsive to the review process: answering questions, making refinements, providing clarification, and rebasing your commits.
+*If your changes are gridlocked please notify [@jeremyf](https://github.com/jeremyf) via a comment on the pull request.*
+
+## Who Will be Doing the Review
+
+Anyone is welcome to contribute to the review process.
+At this stage in the development, [@jeremyf](https://github.com/jeremyf) is the only person that will merge pull requests.
+
+# Merging Changes
+
+*If a pull request has received at least one Thumbs Up, but has still not been merged, please notify [@jeremyf](https://github.com/jeremyf) via a comment on the pull request.*
+
+**As the submitter,** you should not merge your own pull request. That is bad form.
+
+**As the reviewer,** if you are comfortable merge the pull request. Otherwise feel free to assign the pull request to another contributor for final merging.
+
+**As the merger,** once you have merged the pull request, go ahead and delete the pull request's topic branch. You are now on the hook for any breaking of the build.

data/Gemfile

@@ -0,0 +1,36 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in hydramata-work.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec path: File.expand_path('..', __FILE__)
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+gem 'equivalent-xml', github: 'jeremyf/equivalent-xml', branch: 'updating-rspec-for-rspec-3'
+gem "rake"
+gem 'coveralls', require: false
+if ! ENV['TRAVIS']
+  gem 'simplecov', require: false
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'guard-rails'
+  gem 'rb-fsevent'
+  gem 'terminal-notifier-guard'
+  gem 'sexp_processor'
+  gem 'ruby_parser'
+  gem 'pry', '~> 0.9.7'
+  gem 'pry-nav'
+end
+
+file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
+if File.exists?(file)
+  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+  instance_eval File.read(file)
+end

data/Guardfile

@@ -0,0 +1,36 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rails', root: 'spec/internal', port: 3001 do
+  watch('Gemfile.lock')
+  watch(%r{^(config|lib)/.*})
+end
+
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/(.+)_helper.rb$}) { |m| "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+#  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+#  watch(%r{^spec/acceptance/(.+)\.feature$})
+#  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+
+

data/LICENSE

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2014 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.
+

data/README.md

@@ -0,0 +1,36 @@
+# Hydramata::Works
+
+[![Version](https://badge.fury.io/rb/hydramata-work.png)](http://badge.fury.io/rb/hydramata-work)
+[![Build Status](https://travis-ci.org/jeremyf/hydramata-work.png?branch=master)](https://travis-ci.org/jeremyf/hydramata-work)
+[![Code Climate](https://codeclimate.com/github/jeremyf/hydramata-work.png)](https://codeclimate.com/github/jeremyf/hydramata-work)
+[![Coverage Status](https://img.shields.io/coveralls/jeremyf/hydramata-work.svg)](https://coveralls.io/r/jeremyf/hydramata-work)
+[![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/github/jeremyf/hydramata-work/master/frames/)
+[![APACHE 2 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+
+Responsible for providing a well defined data-structure to ease the interaction between differing layers of an application:
+
+* Persistence Layer
+* In Memory
+* Rendering/Output Buffer
+
+## Getting Started
+
+Presently Hydramata::Works is a work in progress, and very much not ready for production usage.
+
+But I would encourage you to:
+
+1. Clone the repository: `git clone https://github.com/jeremyf/hydramata-work.git hydramata-work`
+1. Change to the repository's directory: `cd hydramata-work`
+1. Install the base dependencies: `bundle install`
+1. Run the default rake task: `rake`
+
+The rake task will build the internal rails application and run all of the tests.
+
+Once you have the `spec/internal` directory built, you can run `rspec` or `rake spec:all`.
+
+## Resources
+
+* [Vision of Hydramata::Works](./VISION.md)
+* [Contributing Guidelines](./CONTRIBUTING.md)
+* [Todo](./TODO.md)
+* [Design Documents](./documents/)

data/Rakefile

@@ -0,0 +1,47 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+begin
+  APP_RAKEFILE = File.expand_path('../spec/internal/Rakefile', __FILE__)
+  load 'rails/tasks/engine.rake'
+rescue LoadError
+  puts "Unable to load all app tasks for #{APP_RAKEFILE}"
+end
+
+require 'engine_cart/rake_task'
+# http://stackoverflow.com/questions/23165506/rails-spring-breaking-generators
+# https://github.com/cbeer/engine_cart/issues/15
+EngineCart.rails_options = '--skip-spring'
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:all) do
+    ENV['COVERAGE'] = 'true'
+  end
+
+  desc 'Run the Travis CI specs'
+  task :travis do
+    ENV['RAILS_ENV'] = 'test'
+    spec_helper = File.expand_path('../spec/spec_slow_helper.rb', __FILE__)
+    ENV['SPEC_OPTS'] = "--profile 20 --require #{spec_helper}"
+    Rake::Task['engine_cart:clean'].invoke
+    Rake::Task['engine_cart:generate'].invoke
+    Rake::Task['spec:all'].invoke
+  end
+end
+
+begin
+  Rake::Task['default'].clear
+rescue RuntimeError
+  puts 'Unable to find :default rake task; No worries.'
+end
+
+Rake::Task['spec'].clear
+
+task spec: 'spec:all'
+task default: 'spec:travis'

data/TODO.md

@@ -0,0 +1,74 @@
+# Todo
+
+This is a non-exhaustive scratch pad for TODO items.
+
+## Top Level Features
+
+These features reflect the movement of data from one layer to another.
+In each layer, there is a concept of a Work and its data structure.
+
+- [x] Fedora -> Memory
+- [x] Memory -> Show HTML
+- [x] Memory -> Show JSON
+- [x] Memory -> Edit HTML
+- [ ] Database -> Memory
+- [ ] Solr -> Memory
+- [ ] Memory -> Fedora
+- [ ] Memory -> Database
+- [ ] Memory -> Solr
+- [ ] Memory -> New HTML
+- [ ] Memory -> Solr Document
+- [X] UI Input for New -> Memory
+- [ ] UI Input for Edit -> Memory
+- [X] Validation in Memory Object
+
+## Low Level Tasks
+
+These should not be considered exhaustive.
+But are instead a parking lot that may be cleared or added to.
+
+- [X] Default entity rendering to include work_type as one of the partial
+      prefixes.
+- [X] Default fieldset rendering to include work_type and fieldset name as the
+      partial prefixes.
+- [X] Default fieldset rendering to include work_type, fieldset name, and
+      predicate name as the partial prefixes.
+- [X] Create Work Type persistence
+- [X] Create Work Type conversion
+- [X] Create Work Type presentation structure persistence
+- [X] Integrate presentation structure persistence with construction of in memory objects for presentation
+- [X] Remove some duplication of Work Type and Predicate (moving towards a Definition concept?)
+- [X] Create some rudimentary seeds for Work Types
+- [X] Create some rudimentary seeds for Work Types presentation structure
+- [X] Create some rudimentary seeds for Predicates
+- [ ] Disambigutate identity vs. name for application usage
+- [X] Allow for the declaration of validations for a given Predicate
+- [ ] Tidy up validation services; Presently it has lots of knowledge of Entity's structure
+- [X] Improve internationalization support by providing a better key path.
+- [X] Add view tests for show templates
+- [ ] Add view tests for edit templates
+- [ ] Reify an object from persistence then apply value changes
+- [ ] Review view rendering path options; Presently the top level work type is created.
+- [X] Add PresentationStructure builder by WorkType; This is done by interrogating the
+      data storage.
+- [X] Add support for multi rails
+- [ ] dom_class should derive from system symbol for identifier
+- [ ] dom_class should accept prefix and suffix
+- [ ] itemprop: for the Property presenter (for Microdata)
+- [X] itemtype for WorkType presenter (RDFa and Microdata)
+- [ ] When persisting Validations make sure to validate that the serialized document is valid
+- [X] Conversion for Entity to EntityPresenter; Or Presenter() conversion
+- [X] Create a NullWorkType concept.
+      It would be helpful to create a Null Work Type, so our application doesn't choke.
+- [X] Add internationalization for Work Type contexts:
+  - [X] Work type name
+  - [X] Work type description
+  - [X] Work type verbose description (fallback to description)
+- [X] Add internationalization for Predicate Set
+  - [X] Predicate set name
+  - [X] Predicate set description
+  - [X] Predicate set verbose description (fallback to description)
+- [X] Add internationalization for Predicate
+  - [X] Predicate label
+  - [X] Predicate description (hint)
+  - [X] Predicate verbose description (fallback to description)