activeadmin 1.0.0.pre1 → 2.9.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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 and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* 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 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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available [here][source].
+
+[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,19 @@
 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 feature request, [make one][new issue]! It's
+generally best if you get confirmation of your bug or approval for your feature
+request this way before starting to code.
 
-### 2. Fork & create a branch
+If you have a general question about activeadmin, you can post it on [Stack
+Overflow], the issue tracker is only for bugs and feature requests.
 
-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.
+### Fork & create a branch
+
+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,34 +23,58 @@ 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`.
+
+You'll also need chrome installed in order to run cucumber scenarios.
 
-Install the development dependencies:
+Now install the development dependencies:
 
 ```sh
 bundle install
 ```
 
+Then install javascript dependencies with [Yarn] (requires a current version of [Node.js]):
+
+```sh
+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
-rake test
+bin/rake
 ```
 
-Which will generate a rails application in `spec/rails` to run the tests against.
+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. Implement your fix or feature
+**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`.
+
+### 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:
 
-### 5. 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.
@@ -59,54 +82,40 @@ a look at your changes in a browser.
 To boot up a test Rails app:
 
 ```sh
-script/local server
-```
-
-This will automatically create a Rails app if none already exists, and store it in the
-`.test-rails-apps` folder. The currently active app is symlinked to `test-rails-app`.
-
-If you have any Bundler issues, call the `use_rails` script then prepend
-the version of rails you would like to use in an environment variable:
-
-```sh
-script/use_rails 4.0.0
-RAILS=4.0.0 script/local server
+bin/rake local server
 ```
 
-You should now be able to open <http://localhost:3000/admin> in your browser. You can log in using:
+This will automatically create a Rails app if none already exists, and store it
+in the `tmp/development_apps` folder.
 
-	User: admin@example.com
-	Password: password
+You should now be able to open <http://localhost:3000/admin> in your browser.
+You can log in using:
 
-If you need to perform any other commands on the test application, use the
-`local` script. For example:
+*User*: admin@example.com
+*Password*: password
 
-To boot the rails console:
+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
-script/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
-script/local rake db:migrate
+bin/rake local db:migrate
 ```
 
-### 6. Run tests against major supported rails versions
+### Get the style right
 
-Once you've implemented your code, got the tests passing, previewed it in a
-browser, you're ready to test it against multiple versions of Rails.
+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.
 
-```sh
-rake test:major_supported_rails
-```
-
-This runs our test suite against a couple of major versions of Rails.
-Travis does essentially the same thing when you open a Pull Request.
-We care about quality, so your PR won't be merged until all tests pass.
-
-### 7. Make a Pull Request
+### 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:
@@ -125,20 +134,62 @@ 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
+
+Github Actions 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
 git pull --rebase upstream master
-git push -f 325-add-japanese-translations
+git push --force-with-lease 325-add-japanese-translations
 ```
+
+### Merging a PR (maintainers only)
+
+A PR can only be merged into master by a maintainer if:
+
+* It is passing CI.
+* It has been approved by at least two maintainers. If it was a maintainer who
+  opened the PR, only one extra approval is needed.
+* It has no requested changes.
+* It is up to date with current master.
+
+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:
+
+* Switch to the master branch and make sure it's up to date.
+* 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.
+* Run one of `bin/rake release:prepare_{prerelease,prepatch,patch,preminor,minor,premajor,major}`, push the result and create a PR.
+* Review and merge the PR. The generated changelog in the PR should include all user visible changes you intend to ship.
+* Run `bin/rake release` from the target branch once the PR is merged.
+
+[chandler]: https://github.com/mattbrictson/chandler#2-configure-credentials
+[Stack Overflow]: http://stackoverflow.com/questions/tagged/activeadmin
+[new issue]: https://github.com/activeadmin/activeadmin/issues/new
+[fork Active Admin]: https://help.github.com/articles/fork-a-repo
+[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/en/github/using-git/about-git-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/LICENSE

@@ -18,8 +18,3 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-Iconic Icons are designed by P.J. Onori and are shared under
-the Creative Commons Attribution-Share Alike 3.0 license:
-http://creativecommons.org/licenses/by-sa/3.0/us
-http://somerandomdude.com/projects/iconic/

data/README.md

@@ -1,79 +1,58 @@
 # Active Admin
 
-Active Admin 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        ](http://img.shields.io/coveralls/activeadmin/activeadmin.svg)               ](https://coveralls.io/r/activeadmin/activeadmin)
-[![Gittip          ](http://img.shields.io/gittip/activeadmin.svg)                              ](https://gittip.com/activeadmin)
-[![Inch CI         ](http://inch-ci.org/github/activeadmin/activeadmin.svg?branch=master)       ](http://inch-ci.org/github/activeadmin/activeadmin)
-[![Stories in Ready](http://badge.waffle.io/activeadmin/activeadmin.png?label=ready&title=ready)](https://waffle.io/activeadmin/activeadmin)
+[![Version         ][rubygems_badge]][rubygems]
+[![Github Actions  ][actions_badge]][actions]
+[![Coverage        ][coverage_badge]][coverage]
+[![Tidelift        ][tidelift_badge]][tidelift]
+[![Inch CI         ][inch_badge]][inch]
 
-## State of the project
-
-### 1.0.0
-
-We're [currently working on 1.0.0](https://github.com/activeadmin/activeadmin/issues?milestone=18),
-which as far as dependencies, moves us from meta_search to Ransack and adds Rails 4 support.
-
-You can get it by tracking master:
-```ruby
-gem 'activeadmin', github: 'activeadmin'
-```
+## Goals
 
-Or you can using rubygems:
-```ruby
-gem 'activeadmin', '~> 1.0.0.pre1'
-```
+* 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.
 
-*Keep in mind that during the time where we use `pre`-release label, things can break in each release!*
+## Getting started
 
-### 0.6.x
+* Check out [the docs][docs].
+* Try the [live demo][demo].
+* The [wiki] includes links to tutorials, articles and sample projects.
 
-The plan is to follow [semantic versioning](http://semver.org/) as of 1.0.0. The 0.6.x line will
-still be maintained, and we will backport bug fixes into future 0.6.x releases. If you don't want
-to have to wait for a release, you can track the branch instead:
+## For enterprise
 
-```ruby
-gem 'activeadmin', github: 'activeadmin', branch: '0-6-stable'
-```
+Active Admin for enterprise is available via the Tidelift subscription. [Learn
+More][tidelift_enterprise].
 
-## Documentation
+## Need help?
 
-Please note that <http://activeadmin.info> is out of date. For the latest docs, check out the
-Github [docs](https://github.com/activeadmin/activeadmin/tree/master/docs#activeadmin-documentation) and the [wiki](https://github.com/activeadmin/activeadmin/wiki).
+Please use [StackOverflow][stackoverflow] for help requests and how-to questions.
 
-## Links
+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.
 
-* Website: <http://www.activeadmin.info> (out of date)
-* Live demo: <http://demo.activeadmin.info/admin>
-* Documentation
-  * Guides: <https://github.com/activeadmin/activeadmin/tree/master/docs>
-  * YARD: <http://rubydoc.info/gems/activeadmin>
-  * Wiki: <https://github.com/activeadmin/activeadmin/wiki>
+Google Groups, IRC #activeadmin and Gitter are not actively monitored.
 
-## Goals
+## Want to contribute?
 
-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.
+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.
 
-## Getting started
+## Want to support us?
 
-Check out [the docs](https://github.com/activeadmin/activeadmin/blob/master/docs/0-installation.md)!
+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.
 
-## Need help?
+You can also support us with a weekly tip via [Liberapay].
 
-Ask us in IRC ([#activeadmin](https://webchat.freenode.net/?channels=activeadmin)), on the
-[mailing list](http://groups.google.com/group/activeadmin), or on
-[Stack Overflow](http://stackoverflow.com/questions/tagged/activeadmin).
-
-## 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
-[@seanlinsley](https://twitter.com/seanlinsley) or [@captainhagbard](https://twitter.com/captainhagbard).
+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
 
@@ -84,15 +63,55 @@ Tool                  | Description
 [Arbre]               | Ruby -> HTML, just like that.
 [Devise]              | Powerful, extensible user authentication
 [Formtastic]          | A Rails form builder plugin with semantically rich and accessible markup
-[Iconic Icons]        | An excellent SVG icon set designed by P.J. Onori
 [Inherited Resources] | Simplifies controllers with pre-built RESTful controller actions
 [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
-[Iconic Icons]: http://somerandomdude.com/projects/iconic
-[Inherited Resources]: https://github.com/josevalim/inherited_resources
-[Kaminari]: https://github.com/amatsuda/kaminari
+[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
+[actions_badge]: https://github.com/activeadmin/activeadmin/workflows/ci/badge.svg
+[actions]: https://github.com/activeadmin/activeadmin/actions
+[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=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