Skip to content

Commit

Permalink
Move hyrax out of -labs
Browse files Browse the repository at this point in the history
  • Loading branch information
jcoyne committed Jun 9, 2017
1 parent e2426fc commit 9bf83f9
Show file tree
Hide file tree
Showing 8 changed files with 44 additions and 44 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Changes proposed in this pull request:
*
*

@samvera-labs/hyrax-code-reviewers
@samvera/hyrax-code-reviewers
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
![Logo](https://raw.githubusercontent.com/samvera-labs/hyrax/gh-pages/assets/images/hyrax_logo_horizontal_white_background.png)
![Logo](https://raw.githubusercontent.com/samvera/hyrax/gh-pages/assets/images/hyrax_logo_horizontal_white_background.png)

Code: [![Version](https://badge.fury.io/rb/hyrax.png)](http://badge.fury.io/rb/hyrax)
[![Build Status](https://travis-ci.org/samvera-labs/hyrax.png?branch=master)](https://travis-ci.org/samvera-labs/hyrax)
[![Coverage Status](https://coveralls.io/repos/github/samvera-labs/hyrax/badge.svg?branch=master)](https://coveralls.io/github/samvera-labs/hyrax?branch=master)
[![Code Climate](https://codeclimate.com/github/samvera-labs/hyrax/badges/gpa.svg)](https://codeclimate.com/github/samvera-labs/hyrax)
[![Dependency Update Status](https://gemnasium.com/samvera-labs/hyrax.png)](https://gemnasium.com/samvera-labs/hyrax)
[![Dependency Maintenance Status](https://dependencyci.com/github/samvera-labs/hyrax/badge)](https://dependencyci.com/github/samvera-labs/hyrax)
[![Build Status](https://travis-ci.org/samvera/hyrax.png?branch=master)](https://travis-ci.org/samvera/hyrax)
[![Coverage Status](https://coveralls.io/repos/github/samvera/hyrax/badge.svg?branch=master)](https://coveralls.io/github/samvera/hyrax?branch=master)
[![Code Climate](https://codeclimate.com/github/samvera/hyrax/badges/gpa.svg)](https://codeclimate.com/github/samvera/hyrax)
[![Dependency Update Status](https://gemnasium.com/samvera/hyrax.png)](https://gemnasium.com/samvera/hyrax)
[![Dependency Maintenance Status](https://dependencyci.com/github/samvera/hyrax/badge)](https://dependencyci.com/github/samvera/hyrax)

Docs: [![Documentation Status](https://inch-ci.org/github/samvera-labs/hyrax.svg?branch=master)](https://inch-ci.org/github/samvera-labs/hyrax)
Docs: [![Documentation Status](https://inch-ci.org/github/samvera/hyrax.svg?branch=master)](https://inch-ci.org/github/samvera/hyrax)
[![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/hyrax)
[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./.github/CONTRIBUTING.md)
[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)

Jump in: [![Slack Status](http://slack.projecthydra.org/badge.svg)](http://slack.projecthydra.org/)
[![Ready Tickets](https://badge.waffle.io/samvera-labs/hyrax.png?label=ready&milestone=2.0.0&title=Ready)](https://waffle.io/samvera-labs/hyrax?milestone=2.0.0)
[![Ready Tickets](https://badge.waffle.io/samvera/hyrax.png?label=ready&milestone=2.0.0&title=Ready)](https://waffle.io/samvera/hyrax?milestone=2.0.0)

# Table of Contents

Expand Down Expand Up @@ -50,7 +50,7 @@ Hyrax is a front-end based on the robust [Samvera](http://projecthydra.org) fram

## Feature list

Hyrax has many features. [Read more about what they are and how to turn them on](https://github.com/samvera-labs/hyrax/wiki/Feature-matrix). See the [Hyrax Management Guide](https://github.com/samvera-labs/hyrax/wiki/Hyrax-Management-Guide) to learn more.
Hyrax has many features. [Read more about what they are and how to turn them on](https://github.com/samvera/hyrax/wiki/Feature-matrix). See the [Hyrax Management Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide) to learn more.

For non-technical documentation about Hyrax, see the Hyrax [documentation site](http://hyr.ax/).

Expand Down Expand Up @@ -83,7 +83,7 @@ Hyrax requires the following software to work:
1. [LibreOffice](#derivatives)
1. [ffmpeg](#transcoding)

**NOTE: The [Hyrax Development Guide](https://github.com/samvera-labs/hyrax/wiki/Hyrax-Development-Guide) has instructions for installing Solr and Fedora in a development environment.**
**NOTE: The [Hyrax Development Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide) has instructions for installing Solr and Fedora in a development environment.**

### Characterization

Expand Down Expand Up @@ -150,7 +150,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
Generate a new Rails application using the template.

```
rails _5.0.3_ new my_app -m https://raw.githubusercontent.com/samvera-labs/hyrax/master/template.rb
rails _5.0.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/master/template.rb
```

Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:
Expand Down Expand Up @@ -197,7 +197,7 @@ class Application < Rails::Application
end
```

**For production applications** you will want to use a more robust message queue system such as [Sidekiq](http://sidekiq.org/). The Hyrax Development Guide has a detailed walkthrough of [installing and configuring Sidekiq](https://github.com/samvera-labs/hyrax/wiki/Using-Sidekiq-with-Hyrax).
**For production applications** you will want to use a more robust message queue system such as [Sidekiq](http://sidekiq.org/). The Hyrax Development Guide has a detailed walkthrough of [installing and configuring Sidekiq](https://github.com/samvera/hyrax/wiki/Using-Sidekiq-with-Hyrax).

## Create default administrative set

Expand Down Expand Up @@ -233,11 +233,11 @@ If your applications requires your work type to be namespaced, namespaces can be
rails generate hyrax:work My/MovingImage
```

You may wish to [customize your work type](https://github.com/samvera-labs/hyrax/wiki/Customizing-your-work-types) now that it's been generated.
You may wish to [customize your work type](https://github.com/samvera/hyrax/wiki/Customizing-your-work-types) now that it's been generated.

# Managing a Hyrax-based app

The [Hyrax Management Guide](https://github.com/samvera-labs/hyrax/wiki/Hyrax-Management-Guide) provides tips for how to manage, customize, and enhance your Hyrax application, including guidance specific to:
The [Hyrax Management Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide) provides tips for how to manage, customize, and enhance your Hyrax application, including guidance specific to:

* Production implementations
* Configuration of background workers
Expand Down Expand Up @@ -272,23 +272,23 @@ Hyrax is available under [the Apache 2.0 license](LICENSE.md).
We'd love to accept your contributions. Please see our guide to [contributing to Hyrax](./.github/CONTRIBUTING.md).
If you'd like to help the development effort and you're not sure where to get started, you can always grab a ticket in the "Ready" column from our [Waffle board](https://waffle.io/samvera-labs/hyrax). There are other ways to help, too.
If you'd like to help the development effort and you're not sure where to get started, you can always grab a ticket in the "Ready" column from our [Waffle board](https://waffle.io/samvera/hyrax). There are other ways to help, too.
* [Contribute a user story](https://github.com/samvera-labs/hyrax/issues/new).
* Help us improve [Hyrax's test coverage](https://coveralls.io/r/samvera-labs/hyrax) or [documentation coverage](https://inch-ci.org/github/samvera-labs/hyrax).
* Refactor away [code smells](https://codeclimate.com/github/samvera-labs/hyrax).
* [Contribute a user story](https://github.com/samvera/hyrax/issues/new).
* Help us improve [Hyrax's test coverage](https://coveralls.io/r/samvera/hyrax) or [documentation coverage](https://inch-ci.org/github/samvera/hyrax).
* Refactor away [code smells](https://codeclimate.com/github/samvera/hyrax).
# Development
The [Hyrax Development Guide](https://github.com/samvera-labs/hyrax/wiki/Hyrax-Development-Guide) is for people who want to modify Hyrax itself, not an application that uses Hyrax.
The [Hyrax Development Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide) is for people who want to modify Hyrax itself, not an application that uses Hyrax.
## Workflow Relationship Diagram
* [Entity Relationship Diagram](./artifacts/entity-relationship-diagram.pdf)
# Release process
See the [release management process](https://github.com/samvera-labs/hyrax/wiki/Release-management-process).
See the [release management process](https://github.com/samvera/hyrax/wiki/Release-management-process).
# Acknowledgments
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Monkey patch Turbolinks to render 401
# See https://github.com/turbolinks/turbolinks/issues/179
# https://github.com/projecthydra-labs/hyrax/issues/617
# https://github.com/samvera/hyrax/issues/617
if Turbolinks?
Turbolinks.HttpRequest.prototype.requestLoaded = ->
@endRequest =>
Expand Down
2 changes: 1 addition & 1 deletion app/controllers/hyrax/admin/admin_sets_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module Hyrax
class Admin::AdminSetsController < ApplicationController
include Hyrax::CollectionsControllerBehavior

# added skip to allow flash notices. see https://github.com/projecthydra-labs/hyrax/issues/202
# added skip to allow flash notices. see https://github.com/samvera/hyrax/issues/202
skip_before_action :filter_docs_with_read_access!
before_action :ensure_manager!
load_and_authorize_resource
Expand Down
4 changes: 2 additions & 2 deletions app/search_builders/hyrax/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ As modified by Hyrax' installer, it includes additional modules and overrides.
- [Blacklight::Solr::SearchBuilderBehavior](https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/solr/search_builder_behavior.rb) associated methods
- [Hydra::AccessControlsEnforcement](https://github.com/projecthydra/hydra-head/blob/master/hydra-access-controls/lib/hydra/access_controls_enforcement.rb) module
- [Blacklight::AccessControls::Enforcement](https://github.com/projectblacklight/blacklight-access_controls/blob/master/lib/blacklight/access_controls/enforcement.rb) ancestor of `Hydra::AccessControlsEnforcement`
- [Hyrax::SearchFilters](https://github.com/projecthydra-labs/hyrax/blob/master/app/search_builders/hyrax/search_filters.rb) module that itself includes:
- [Hyrax::SearchFilters](https://github.com/samvera/hyrax/blob/master/app/search_builders/hyrax/search_filters.rb) module that itself includes:
- [BlacklightAdvancedSearch::AdvancedSearchBuilder](https://github.com/projectblacklight/blacklight_advanced_search/blob/master/lib/blacklight_advanced_search/advanced_search_builder.rb) more magic for compound Boolean queries
- [Hyrax::FilterByType](https://github.com/projecthydra-labs/hyrax/blob/master/app/search_builders/hyrax/filter_by_type.rb) Collection vs. Work filtering, specifically the `filter_models` method
- [Hyrax::FilterByType](https://github.com/samvera/hyrax/blob/master/app/search_builders/hyrax/filter_by_type.rb) Collection vs. Work filtering, specifically the `filter_models` method

This is not a comprehensive list, but it is sufficient to trace some of the complexity of interaction between various layers.

Expand Down
2 changes: 1 addition & 1 deletion app/search_builders/hyrax/collection_search_builder.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Hyrax
# It includes Blacklight::Solr::SearchBuilderBehavior, Hydra::AccessControlsEnforcement, Hyrax::SearchFilters
# @see https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/search_builder.rb Blacklight::SearchBuilder parent
# @see https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/solr/search_builder_behavior.rb Blacklight::Solr::SearchBuilderBehavior
# @see https://github.com/projecthydra-labs/hyrax/blob/master/app/search_builders/hyrax/README.md SearchBuilders README
# @see https://github.com/samvera/hyrax/blob/master/app/search_builders/hyrax/README.md SearchBuilders README
# @note the default_processor_chain defined by Blacklight::Solr::SearchBuilderBehavior provides many possible points of override
#
class CollectionSearchBuilder < ::SearchBuilder
Expand Down
34 changes: 17 additions & 17 deletions artifacts/entity-relationship-diagram.dot
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,42 @@ digraph models_diagram {

subgraph 0 {
node[color=green penwidth=2]
"AdminSet" [label="{ AdminSet | Root concept for deposit }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/admin_set.rb";]
"PermissionTemplate" [label="{ Hyrax::PermissionTemplate | Permissions to apply\nto deposited items }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/hyrax/permission_template.rb";]
"Sipity::Workflow" [label="{ Sipity::Workflow | State machine for \ntransitioning Work's state }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/workflow.rb";]
"AdminSet" [label="{ AdminSet | Root concept for deposit }" URL="http://github.com/samvera/hyrax/blob/master/app/models/admin_set.rb";]
"PermissionTemplate" [label="{ Hyrax::PermissionTemplate | Permissions to apply\nto deposited items }" URL="http://github.com/samvera/hyrax/blob/master/app/models/hyrax/permission_template.rb";]
"Sipity::Workflow" [label="{ Sipity::Workflow | State machine for \ntransitioning Work's state }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow.rb";]
}

subgraph 2 {
node[color=blue penwidth=2]
"Sipity::Agent" [label="{ Sipity::Agent | proxy for user or group }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/agent.rb";]
"Sipity::Agent" [label="{ Sipity::Agent | proxy for user or group }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/agent.rb";]
"User" [label="{ User | \<Conceptual\> }"]
"Group" [label="{ Group | \<Conceptual\> }"]
"GroupMembership" [label="{ GroupMembership | \<Conceptual\> }"]
}

subgraph 3 {
"Sipity::EntitySpecificResponsibility" [label="{ Sipity::EntitySpecificResponsibility | The given Sipity::Agent\n has the given role\n for the specific work }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/entity_specific_responsibility.rb";]
"Sipity::WorkflowAction" [label="{ Sipity::WorkflowAction | The valid actions\n for the given workflow }"] [URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/workflow_action.rb";]
"Sipity::WorkflowResponsibility" [label="{ Sipity::WorkflowResponsibility | The given Sipity::Agent\n has the given role\n for all works in this workflow }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/workflow_responsibility.rb";]
"Sipity::WorkflowRole" [label="{ Sipity::WorkflowRole | The valid roles \n for the given workflow }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/workflow_role.rb";]
"Sipity::WorkflowState" [label="{ Sipity::WorkflowState | The valid states\n for the given workflow }"] [URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/workflow_state.rb";]
"Sipity::WorkflowStateAction" [label="{ Sipity::WorkflowStateAction | The actions that can\n be taken for the\n given workflow & state }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/workflow_state_action.rb";]
"Sipity::WorkflowStateActionPermission" [label="{ Sipity::WorkflowStateActionPermission | The role required to \n take the action \n for the given workflow }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/workflow_state_action_permission.rb";]
"Sipity::Role" [label="{ Sipity::Role | All of the named \n roles for the site }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/role.rb";]
"Sipity::Method" [label=" { Sipity::Method | Arbitrary lambdas to call\nwhen action is taken}" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/method.rb";]
"Sipity::EntitySpecificResponsibility" [label="{ Sipity::EntitySpecificResponsibility | The given Sipity::Agent\n has the given role\n for the specific work }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/entity_specific_responsibility.rb";]
"Sipity::WorkflowAction" [label="{ Sipity::WorkflowAction | The valid actions\n for the given workflow }"] [URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_action.rb";]
"Sipity::WorkflowResponsibility" [label="{ Sipity::WorkflowResponsibility | The given Sipity::Agent\n has the given role\n for all works in this workflow }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_responsibility.rb";]
"Sipity::WorkflowRole" [label="{ Sipity::WorkflowRole | The valid roles \n for the given workflow }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_role.rb";]
"Sipity::WorkflowState" [label="{ Sipity::WorkflowState | The valid states\n for the given workflow }"] [URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_state.rb";]
"Sipity::WorkflowStateAction" [label="{ Sipity::WorkflowStateAction | The actions that can\n be taken for the\n given workflow & state }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_state_action.rb";]
"Sipity::WorkflowStateActionPermission" [label="{ Sipity::WorkflowStateActionPermission | The role required to \n take the action \n for the given workflow }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/workflow_state_action_permission.rb";]
"Sipity::Role" [label="{ Sipity::Role | All of the named \n roles for the site }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/role.rb";]
"Sipity::Method" [label=" { Sipity::Method | Arbitrary lambdas to call\nwhen action is taken}" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/method.rb";]
}

subgraph 4 {
node[color=gold penwidth=2]
"Sipity::NotifiableContext" [label=" { Sipity::NotifiableContext | Arbitrary lambdas to call\nwhen action is taken}" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/notifiable_context.rb";]
"Sipity::Notification" [label=" { Sipity::Notification | A type of notification to send }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/notification.rb";]
"Sipity::NotificationRecipient" [label=" { Sipity::NotificationRecipient | Who receives the notification }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/notification_recipient.rb";]
"Sipity::NotifiableContext" [label=" { Sipity::NotifiableContext | Arbitrary lambdas to call\nwhen action is taken}" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/notifiable_context.rb";]
"Sipity::Notification" [label=" { Sipity::Notification | A type of notification to send }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/notification.rb";]
"Sipity::NotificationRecipient" [label=" { Sipity::NotificationRecipient | Who receives the notification }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/notification_recipient.rb";]
}

subgraph 1 {
node[color=red penwidth=2]
"AbstractWork" [label="{ Work | \<Conceptual\> | \<Generated\> }"]
"Sipity::Entity" [label="{ Sipity::Entity | A database proxy for \n a Work in Fedora }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/entity.rb";]
"Sipity::Entity" [label="{ Sipity::Entity | A database proxy for \n a Work in Fedora }" URL="http://github.com/samvera/hyrax/blob/master/app/models/sipity/entity.rb";]
}

"AdminSet" -> "PermissionTemplate" [arrowtail=none, arrowhead=none, dir=both]
Expand Down
2 changes: 1 addition & 1 deletion hyrax.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
be turned on in the administrative dashboard or added through plugins.
EOF

spec.homepage = "http://github.com/projecthydra-labs/hyrax"
spec.homepage = "http://github.com/samvera/hyrax"

spec.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
spec.executables = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
Expand Down

0 comments on commit 9bf83f9

Please sign in to comment.