Skip to content

Commit

Permalink
Merge pull request #5830 from samvera/koppie
Browse files Browse the repository at this point in the history
Create .koppie (.dassie without Fedora)
  • Loading branch information
dlpierce authored Sep 2, 2022
2 parents 0b506e7 + 1f0c01c commit 76104da
Show file tree
Hide file tree
Showing 255 changed files with 12,766 additions and 2 deletions.
43 changes: 43 additions & 0 deletions .koppie/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
CHROME_HEADLESS_MODE=false
DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL=true
DATABASE_TEST_URL=postgresql://hyrax_user:hyrax_password@postgres/hyrax_test?pool=5
DATABASE_URL=postgresql://hyrax_user:hyrax_password@postgres/hyrax?pool=5
DB_HOST=postgres
DB_NAME=koppie
DB_PASSWORD=hyrax_password
DB_PORT=5432
DB_USERNAME=hyrax_user
FCREPO_HOST=
FCREPO_PORT=
FCREPO_REST_PATH=
FCREPO_TEST_BASE_PATH=
HUB_URL=http://chrome:4444/wd/hub
HYRAX_DERIVATIVES_PATH=/app/samvera/hyrax-webapp/derivatives/
HYRAX_ENGINE_PATH=/app/samvera/hyrax-engine
HYRAX_UPLOAD_PATH=/app/samvera/hyrax-webapp/uploads/
HYRAX_VALKYRIE=true
IN_DOCKER=true
METADATA_DATABASE_NAME=koppie_metadata_development
POSTGRES_DB=koppie
POSTGRES_HOST_AUTH_METHOD=trust
POSTGRES_PASSWORD=hyrax_password
POSTGRES_USER=hyrax_user
RACK_ENV=development
RAILS_ENV=development
RAILS_ROOT=.koppie
RAILS_LOG_TO_STDOUT=true
RAILS_QUEUE=sidekiq
REDIS_HOST=redis
REDIS_PASSWORD=sidekickin
REDIS_URL=redis://noop:sidekickin@redis:6379
SEED_KOPPIE=true
SKIP_SELENIUM=
SOLR_COLLECTION_NAME=koppie
SOLR_CORE_CONF_DIR=/opt/solr/server/configsets/hyraxconf
SOLR_CORES=koppie
SOLR_HOST=solr
SOLR_PORT=8983
SOLR_URL=http://solr:8983/solr/koppie
VALKYRIE_SOLR_CORE=koppie
VALKYRIE_SOLR_HOST=solr
VALKYRIE_SOLR_PORT=8983
48 changes: 48 additions & 0 deletions .koppie/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# See https://help.github.com/articles/ignoring-files for more about ignoring files.
#
# If you find yourself ignoring temporary files generated by your text editor
# or operating system, you probably want to add a global ignore instead:
# git config --global core.excludesfile '~/.gitignore_global'

# Ignore bundler config.
/.bundle

# Ignore the default SQLite database.
/db/*.sqlite3
/db/*.sqlite3-journal

# Ignore all logfiles and tempfiles.
/log/*
/tmp/*
!/log/.keep
!/tmp/.keep
!/tmp/derivatives/.keep
!/tmp/uploads/.keep
!/tmp/uploads/cache/.keep

# From Rails 5.1
/node_modules
/yarn-error.log

# Ignore Byebug command history file.
.byebug_history

# Ignore Ruby artifacts
/.ruby-*

# Ignore uploaded files in development
/storage/*
!/storage/.keep

# Ignore master key for decrypting credentials and more.
/config/master.key

/public/assets
/public/files
/public/uv
/public/branding/*
!public/branding/.keep

/spec/examples.txt

fits.log
2 changes: 2 additions & 0 deletions .koppie/.rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
--color
--require spec_helper
36 changes: 36 additions & 0 deletions .koppie/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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.lyrasis.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.lyrasis.org/display/samvera/Samvera+Community+Helpers)
([email](mailto:helpers@samvera.org)), a community member you
trust, or the
[Samvera Steering Group](https://wiki.lyrasis.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.lyrasis.org/display/samvera/Anti-Harassment+Policy)
should be consulted for fuller details.
192 changes: 192 additions & 0 deletions .koppie/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
# How to Contribute

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.

## 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.

[Samvera Community Intellectual Property Licensing and Ownership](https://samvera.atlassian.net/wiki/x/AwonG)

You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.

## Language

The language we use matters. Today, tomorrow, and for years to come
people will read the code we write. They will judge us for our
design, logic, and the words we use to describe the system.

Our words should be accessible. Favor descriptive words that give
meaning while avoiding reinforcing systemic inequities. For example,
in the Samvera community, we should favor using allowed\_list instead
of whitelist, denied\_list instead of blacklist, or source/copy
instead of master/slave.

We're going to get it wrong, but this is a call to keep working to
make it right. View our code and the words we choose as a chance to
have a conversation. A chance to grow an understanding of the systems
we develop as well as the systems in which we live.

See [“Blacklists” and “whitelists”: a salutary warning concerning the
prevalence of racist language in discussions of predatory
publishing](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6148600/) for
further details.

## 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](https://github.com/samvera-labs/nurax-pg/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 `main` branch.
* To quickly create a topic branch based on `main`; `git branch fix/main/my_contribution main`
* Then checkout the new branch with `git checkout fix/main/my_contribution`.
* Please avoid working directly on the `main` branch.
* Please do not create a branch called `master`. (See note below.)
* 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.

NOTE: This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct)
and [language recommendations](#language).
Please ***do not*** create a branch called `master` for this repository or as part of
your pull request; the branch will either need to be removed or renamed before it can
be considered for inclusion in the code base and history of this repository.

### 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.
* 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

* 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. main)
* `git checkout main`
* `git pull --rebase`
* `git checkout <your-branch>`
* `git rebase main`
* 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 main` ([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. [CircleCI](https://circleci.com/gh/samvera) - where our automated tests are running
2. RuboCop/Bixby - 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 (CI tests are 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 Continuous Integration 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](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/)
55 changes: 55 additions & 0 deletions .koppie/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
if @sources.global_rubygems_source == Bundler::SourceList.new.global_rubygems_source
Bundler.ui.info '[Koppie] Adding global rubygems source.'
source 'https://rubygems.org'
else
Bundler.ui.info "[Koppie] Global rubygems source already set: #{@sources.global_rubygems_source.inspect}"
end
git_source(:github) { |repo| "https://github.com/#{repo}.git" }

ruby '2.7.6'

gem 'bootsnap', '>= 1.1.0', require: false
gem 'bootstrap', '~> 4.0'
gem 'coffee-rails', '~> 4.2'
gem 'dalli'
gem 'devise', '4.8.0'
gem 'devise-guests', '0.8.1'
gem 'dotenv-rails'
gem 'hydra-role-management'
gemspec name: 'hyrax', path: ENV.fetch('HYRAX_ENGINE_PATH', '..')
gem 'jbuilder', '~> 2.5'
gem 'jquery-rails'
gem 'pg', '~> 1.3'
gem 'puma', '~> 5.5.2'
gem 'rails', '~> 6.0.5'
gem 'riiif', '~> 2.1'
gem 'rsolr', '>= 1.0', '< 3'
gem 'sass-rails', '~> 6.0'
gem 'sidekiq', '~> 6.4'
gem 'turbolinks', '~> 5'
gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
gem 'uglifier', '>= 1.3.0'
gem 'valkyrie', '~> 2', '>= 2.1.1'

group :development do
gem 'better_errors' # add command line in browser when errors
gem 'binding_of_caller' # deeper stack trace used by better errors

# Access an interactive console on exception pages or by calling 'console' anywhere in the code.
gem 'web-console', '>= 3.3.0'
gem 'listen', '>= 3.0.5', '< 3.2'
# Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
gem 'spring'
gem 'spring-watcher-listen', '~> 2.0.0'
end

group :development, :test do
gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
gem "pry-byebug"
gem "pry-doc"
gem "pry-rails"
gem "pry-rescue"
gem 'rspec-rails'
gem 'solr_wrapper', '>= 0.3'
end
Loading

0 comments on commit 76104da

Please sign in to comment.