activeadmin 1.1.0 → 2.5.0

data/CODE_OF_CONDUCT.md

@@ -1,22 +1,74 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic addresses, without explicit permission
-* Other unethical or unprofessional conduct.
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting one or more of the project maintainers. All complaints
+will be reviewed and investigated and will result in a response that is deemed
+necessary and appropriate to the circumstances. The project team is obligated to
+maintain confidentiality with regard to the reporter of an incident. Further
+details of specific enforcement policies may be posted separately.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
 
-This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+## Attribution
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available [here][source].
 
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
+[homepage]: https://www.contributor-covenant.org
+[source]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

data/CONTRIBUTING.md

@@ -3,20 +3,17 @@
 First off, thank you for considering contributing to Active Admin. It's people
 like you that make Active Admin such a great tool.
 
-### 1. Where do I go from here?
+### Where do I go from here?
 
-If you've noticed a bug or have a question that doesn't belong on the
-[mailing list](http://groups.google.com/group/activeadmin) or
-[Stack Overflow](http://stackoverflow.com/questions/tagged/activeadmin),
-[search the issue tracker](https://github.com/activeadmin/activeadmin/issues?q=something)
-to see if someone else in the community has already created a ticket.
-If not, go ahead and [make one](https://github.com/activeadmin/activeadmin/issues/new)!
+If you've noticed a bug or have a question that doesn't belong on the [mailing
+list] or [Stack Overflow], [search the issue tracker] to see if someone else in
+the community has already created a ticket. If not, go ahead and [make one][new
+issue]!
 
-### 2. Fork & create a branch
+### Fork & create a branch
 
-If this is something you think you can fix, then
-[fork Active Admin](https://help.github.com/articles/fork-a-repo)
-and create a branch with a descriptive name.
+If this is something you think you can fix, then [fork Active Admin] and create
+a branch with a descriptive name.
 
 A good branch name would be (where issue #325 is the ticket you're working on):
 
@@ -24,63 +21,74 @@ A good branch name would be (where issue #325 is the ticket you're working on):
 git checkout -b 325-add-japanese-translations
 ```
 
-### 3. Get the test suite running
+### Get the test suite running
 
 Make sure you're using a recent ruby and have the `bundler` gem installed, at
 least version `1.14.3`.
 
-Select the Gemfile for your preferred Rails version, preferably the latest:
+You'll also need chrome installed in order to run cucumber scenarios.
+
+Now install the development dependencies:
 
 ```sh
-export BUNDLE_GEMFILE=gemfiles/rails_51.gemfile
+bundle install
 ```
 
-Now install the development dependencies:
+Then install javascript dependencies with [Yarn] (requires a current version of [Node.js]):
 
 ```sh
-bundle install
+bin/yarn install
+```
+
+JS assets are located in `app/javascript/active_admin`. The config will take care of compiling a complete bundle with [Rollup] using the `build` script and exported to `app/assets/javascripts/active_admin/base.js` ready to be used by Sprockets.
+
+To update javascript bundle run (add `-w` flag for watch mode):
+
+```sh
+bin/yarn build
 ```
 
 Now you should be able to run the entire suite using:
 
 ```sh
-bundle exec rake
+bin/rake
 ```
 
-The test run will generate a sample Rails application in `spec/rails` to run the
+The test run will generate a sample Rails application in `tmp/test_apps` to run the
 tests against.
 
-If your tests are passing locally but they're failing on Travis, reset your test
-environment:
+If you want to test against a Rails version different from the latest, make sure
+you use the correct Gemfile, for example:
 
 ```sh
-rm -rf spec/rails && bundle update
+export BUNDLE_GEMFILE=gemfiles/rails_60/Gemfile
 ```
 
-### 4. Did you find a bug?
+**Warning** SCSS assets are aimed to be used indifferently with Sprockets **and** webpacker.
+As such, make sure not to use any sass-rails directives such as `asset-url` or `image-url`.
+
+### Did you find a bug?
 
-* **Ensure the bug was not already reported** by [searching all
-  issues](https://github.com/activeadmin/activeadmin/issues?q=).
+* **Ensure the bug was not already reported** by [searching all issues].
 
-* If you're unable to find an open issue addressing the problem, [open a new
-  one](https://github.com/activeadmin/activeadmin/issues/new).  Be sure to
-  include a **title and clear description**, as much relevant information as
-  possible, and a **code sample** or an **executable test case** demonstrating
-  the expected behavior that is not occurring.
+* If you're unable to find an open issue addressing the problem,
+  [open a new one][new issue]. Be sure to include a **title and clear
+  description**, as much relevant information as possible, and a **code sample**
+  or an **executable test case** demonstrating the expected behavior that is not
+  occurring.
 
 * If possible, use the relevant bug report templates to create the issue.
   Simply copy the content of the appropriate template into a .rb file, make the
   necessary changes to demonstrate the issue, and **paste the content into the
   issue description**:
-  * [**ActiveAdmin** master
-    issues](https://github.com/activeadmin/activeadmin/blob/master/lib/bug_report_templates/active_admin_master.rb)
+  * [**ActiveAdmin** master issues][master template]
 
-### 5. Implement your fix or feature
+### Implement your fix or feature
 
 At this point, you're ready to make your changes! Feel free to ask for help;
 everyone is a beginner at first :smile_cat:
 
-### 6. View your changes in a Rails application
+### View your changes in a Rails application
 
 Active Admin is meant to be used by humans, not cucumbers. So make sure to take
 a look at your changes in a browser.
@@ -88,11 +96,11 @@ a look at your changes in a browser.
 To boot up a test Rails app:
 
 ```sh
-bundle exec rake local server
+bin/rake local server
 ```
 
 This will automatically create a Rails app if none already exists, and store it
-in the `.test-rails-apps` folder.
+in the `tmp/development_apps` folder.
 
 You should now be able to open <http://localhost:3000/admin> in your browser.
 You can log in using:
@@ -104,16 +112,40 @@ If you need to perform any other commands on the test application, just pass
 them to the `local` rake task. For example, to boot the rails console:
 
 ```sh
-bundle exec rake local console
+bin/rake local console
 ```
 
-Or to migrate the database:
+Or to migrate the database, if you create a new migration or just play around
+with the db:
 
 ```sh
-bundle exec rake local db:migrate
+bin/rake local db:migrate
 ```
 
-### 7. Make a Pull Request
+### Get the style right
+
+Your patch should follow the same conventions & pass the same code quality
+checks as the rest of the project. `bin/rake lint` will give you feedback in
+this regard. You can check & fix style issues by running each linter
+individually. Run `bin/rake -T lint` to see the available linters.
+
+### Add a changelog entry
+
+If your PR includes user-observable changes, you'll be asked to add a changelog
+entry following the existing changelog format.
+
+The changelog format is the following:
+
+* One line per PR describing your fix or enhancement.
+* Entries end with a dot, followed by "[#pr-number] by [@github-username]".
+* Entries are added under the "Unreleased" section at the top of the file, under
+  the "Bug Fixes" or "Enhancements" subsection.
+* References to github usernames and pull requests use [shortcut reference
+  links].
+* Your github username reference definition is included in the correct
+  alphabetical position at the bottom of the file.
+
+### Make a Pull Request
 
 At this point, you should switch back to your master branch and make sure it's
 up to date with Active Admin's master branch:
@@ -132,26 +164,22 @@ git rebase master
 git push --set-upstream origin 325-add-japanese-translations
 ```
 
-Finally, go to GitHub and
-[make a Pull Request](https://help.github.com/articles/creating-a-pull-request)
-:D
+Finally, go to GitHub and [make a Pull Request][] :D
 
-Travis CI will run our test suite against all supported Rails versions. We care
+CircleCI will run our test suite against all supported Rails versions. We care
 about quality, so your PR won't be merged until all tests pass. It's unlikely,
 but it's possible that your changes pass tests in one Rails version but fail in
 another. In that case, you'll have to setup your development environment (as
 explained in step 3) to use the problematic Rails version, and investigate
 what's going on!
 
-### 8. Keeping your Pull Request updated
+### Keeping your Pull Request updated
 
 If a maintainer asks you to "rebase" your PR, they're saying that a lot of code
 has changed, and that you need to update your branch so it's easier to merge.
 
-To learn more about rebasing in Git, there are a lot of
-[good](http://git-scm.com/book/en/Git-Branching-Rebasing)
-[resources](https://help.github.com/articles/interactive-rebase),
-but here's the suggested workflow:
+To learn more about rebasing in Git, there are a lot of [good][git rebasing]
+[resources][interactive rebase] but here's the suggested workflow:
 
 ```sh
 git checkout 325-add-japanese-translations
@@ -159,7 +187,7 @@ git pull --rebase upstream master
 git push --force-with-lease 325-add-japanese-translations
 ```
 
-### 9. Merging a PR (maintainers only)
+### Merging a PR (maintainers only)
 
 A PR can only be merged into master by a maintainer if:
 
@@ -171,3 +199,43 @@ A PR can only be merged into master by a maintainer if:
 
 Any maintainer is allowed to merge a PR if all of these conditions are
 met.
+
+### Shipping a release (maintainers only)
+
+Maintainers need to do the following to push out a release:
+
+* Make sure all pull requests are in and that changelog is current
+* Update `version.rb` file and changelog with new version number
+* If it's not a patch level release, create a stable branch for that release,
+  otherwise switch to the stable branch corresponding to the patch release you
+  want to ship:
+
+  ```sh
+  git checkout master
+  git fetch activeadmin
+  git rebase activeadmin/master
+  # If the release is 2.1.x then this should be: 2-1-stable
+  git checkout -b N-N-stable
+  git push activeadmin N-N-stable:N-N-stable
+  ```
+
+* Make sure you have [chandler] properly configured. Chandler is used to
+  automatically submit github release notes from the changelog right after
+  pushing the gem to rubygems.
+* `bin/rake release`
+
+[chandler]: https://github.com/mattbrictson/chandler#2-configure-credentials
+[mailing list]: http://groups.google.com/group/activeadmin
+[Stack Overflow]: http://stackoverflow.com/questions/tagged/activeadmin
+[search the issue tracker]: https://github.com/activeadmin/activeadmin/issues?q=something
+[new issue]: https://github.com/activeadmin/activeadmin/issues/new
+[fork Active Admin]: https://help.github.com/articles/fork-a-repo
+[searching all issues]: https://github.com/activeadmin/activeadmin/issues?q=
+[master template]: https://github.com/activeadmin/activeadmin/blob/master/tasks/bug_report_template.rb
+[make a pull request]: https://help.github.com/articles/creating-a-pull-request
+[git rebasing]: http://git-scm.com/book/en/Git-Branching-Rebasing
+[interactive rebase]: https://help.github.com/articles/interactive-rebase
+[shortcut reference links]: https://github.github.com/gfm/#shortcut-reference-link
+[Rollup]: https://rollupjs.org/guide/en/#quick-start
+[Yarn]: https://yarnpkg.com/en/docs/install
+[Node.js]: https://nodejs.org/en/

data/README.md

@@ -1,30 +1,34 @@
 # Active Admin
 
-[Active Admin](https://www.activeadmin.info) is a Ruby on Rails framework for creating elegant backends for website administration.
+[Active Admin](https://activeadmin.info) is a Ruby on Rails framework for
+creating elegant backends for website administration.
 
-[![Version         ](http://img.shields.io/gem/v/activeadmin.svg)                               ](https://rubygems.org/gems/activeadmin)
-[![Travis CI       ](http://img.shields.io/travis/activeadmin/activeadmin/master.svg)           ](https://travis-ci.org/activeadmin/activeadmin)
-[![Quality         ](http://img.shields.io/codeclimate/github/activeadmin/activeadmin.svg)      ](https://codeclimate.com/github/activeadmin/activeadmin)
-[![Coverage        ](https://codecov.io/gh/activeadmin/activeadmin/branch/master/graph/badge.svg)](https://codecov.io/gh/activeadmin/activeadmin)
-[![Inch CI         ](http://inch-ci.org/github/activeadmin/activeadmin.svg?branch=master)       ](http://inch-ci.org/github/activeadmin/activeadmin)
-[![Gratipay Team   ](https://img.shields.io/gratipay/team/Active-Admin.svg)](https://gratipay.com/Active-Admin/)
+[![Version         ][rubygems_badge]][rubygems]
+[![Circle CI       ][circle_badge]][circle]
+[![Coverage        ][coverage_badge]][coverage]
+[![Tidelift        ][tidelift_badge]][tidelift]
+[![Inch CI         ][inch_badge]][inch]
 
 ## Goals
 
-1. Enable developers to quickly create good-looking administration interfaces.
-2. Build a DSL for developers and an interface for businesses.
-3. Ensure that developers can easily customize every nook and cranny.
+* Enable developers to quickly create good-looking administration interfaces.
+* Build a DSL for developers and an interface for businesses.
+* Ensure that developers can easily customize every nook and cranny.
 
 ## Getting started
 
-* Check out [the docs](http://activeadmin.info/0-installation.html)!
-* Try the [live demo](http://demo.activeadmin.info/admin)
-* The [wiki](https://github.com/activeadmin/activeadmin/wiki) includes links to tutorials, articles and sample projects.
+* Check out [the docs][docs].
+* Try the [live demo][demo].
+* The [wiki] includes links to tutorials, articles and sample projects.
+
+## For enterprise
+
+Active Admin for enterprise is available via the Tidelift subscription. [Learn
+More][tidelift_enterprise].
 
 ## Need help?
 
-Please use [StackOverflow](http://stackoverflow.com/questions/tagged/activeadmin) for
-help requests and how-to questions.
+Please use [StackOverflow][stackoverflow] for help requests and how-to questions.
 
 Please open GitHub issues for bugs and enhancements only, not general help requests.
 Please search previous issues (and Google and StackOverflow) before creating a new issue.
@@ -33,14 +37,22 @@ Google Groups, IRC #activeadmin and Gitter are not actively monitored.
 
 ## Want to contribute?
 
-The [contributing guide](https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md)
-is a good place to start. If you have questions, feel free to ask.
+If you want to contribute through code or documentation, the [Contributing
+guide is the best place to start][contributing]. If you have questions, feel free
+to ask.
 
 ## Want to support us?
 
-You can support us with a weekly tip via [Gratipay](https://gratipay.com).
+If you want to support us financially, you can [help fund the project
+through a Tidelift subscription][tidelift_support]. By buying a Tidelift subscription
+you make sure your whole dependency stack is properly maintained, while also
+getting a comprehensive view of outdated dependencies, new releases, security
+alerts, and licensing compatibility issues.
+
+You can also support us with a weekly tip via [Liberapay].
 
-[![Support via Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.1.3/dist/gratipay.png)](https://gratipay.com/Active-Admin)
+Finally, we have an [Open Collective][opencollective page] where you can become a backer or
+sponsor for the project, and also submit expenses to it.
 
 ## Dependencies
 
@@ -55,9 +67,51 @@ Tool                  | Description
 [Kaminari]            | Elegant pagination for any sort of collection
 [Ransack]             | Provides a simple search API to query your data
 
+## Security contact information
+
+Please use the Tidelift security contact to [report a security vulnerability][Tidelift security contact].
+Tidelift will coordinate the fix and disclosure.
+
+## Acknowledgements
+
+Thanks to [Greg Bell][Greg] for creating and sharing this project with the open source community.
+
+Thanks to [all the people that ever contributed through code][contributors] or
+other means such as bug reports, issue triaging, feature suggestions, code
+snippet tips, Slack discussions and so on.
+
+Thanks to [Tidelift][tidelift] and all our Tidelift subscribers.
+
+Thanks to [Open Collective][opencollective contributors] and all our Open Collective contributors.
+
 [Arbre]: https://github.com/activeadmin/arbre
 [Devise]: https://github.com/plataformatec/devise
 [Formtastic]: https://github.com/justinfrench/formtastic
 [Inherited Resources]: https://github.com/activeadmin/inherited_resources
 [Kaminari]: https://github.com/kaminari/kaminari
 [Ransack]: https://github.com/activerecord-hackery/ransack
+
+[rubygems_badge]: http://img.shields.io/gem/v/activeadmin.svg
+[rubygems]: https://rubygems.org/gems/activeadmin
+[circle_badge]: https://circleci.com/gh/activeadmin/activeadmin/tree/master.svg
+[circle]: https://circleci.com/gh/activeadmin/activeadmin/tree/master
+[coverage_badge]: https://api.codeclimate.com/v1/badges/779e407d22bacff19733/test_coverage
+[coverage]: https://codeclimate.com/github/activeadmin/activeadmin/test_coverage
+[inch_badge]: http://inch-ci.org/github/activeadmin/activeadmin.svg?branch=master
+[inch]: http://inch-ci.org/github/activeadmin/activeadmin
+[tidelift_badge]: https://tidelift.com/badges/github/activeadmin/activeadmin
+[tidelift]: https://tidelift.com/subscription/pkg/rubygems-activeadmin?utm_source=rubygems-activeadmin&utm_medium=readme
+[tidelift_enterprise]: https://tidelift.com/subscription/pkg/rubygems-activeadmin?utm_source=rubygems-activeadmin&utm_medium=referral&utm_campaign=github&utm_content=enterprise
+[tidelift_support]: https://tidelift.com/subscription/pkg/rubygems-activeadmin?utm_source=rubygems-activeadmin&utm_medium=referral&utm_campaign=github&utm_content=support
+
+[docs]: http://activeadmin.info/0-installation.html
+[demo]: http://demo.activeadmin.info/admin
+[wiki]: https://github.com/activeadmin/activeadmin/wiki
+[stackoverflow]: http://stackoverflow.com/questions/tagged/activeadmin
+[contributing]: https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md
+[Liberapay]: https://liberapay.com/Active-Admin/donate
+[Tidelift security contact]: https://tidelift.com/security
+[Greg]: https://github.com/gregbell
+[contributors]: https://github.com/activeadmin/activeadmin/graphs/contributors
+[opencollective page]: https://opencollective.com/activeadmin
+[opencollective contributors]: https://opencollective.com/activeadmin#contributors