activeadmin 0.6.6 → 1.0.0.pre1

data/CONTRIBUTING.md

@@ -1,121 +1,144 @@
 ## Contributing
 
-This is a guide to contributing to Active Admin. It should walk you through the
-major steps to contributing code to the project.
+First off, thank you for considering contributing to Active Admin. It's people
+like you that make Active Admin such a great tool.
 
-### 0. 'The test suite is failing locally!'
+### 1. Where do I go from here?
 
-If your test suite is failing locally and the 
-[Travis build](https://secure.travis-ci.org/gregbell/active_admin.png?branch=master)
- is passing, you've likely already generated the rails app that is used by 
-ActiveAdmin's test suite and the generated rails app has erroneous files.
+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)!
 
-To fix this, remove the generated rails app by deleting the directory and its 
-contents (`rm -rf spec/rails`) and then re-running the test suite.
+### 2. Fork & create a branch
 
-### 1. Create an Issue on GitHub
+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.
 
-The first step to contributing to Active Admin is creating a ticket in our
-[ticketing system on GitHub](https://github.com/gregbell/active_admin/issues).
-The community has been hard at work already, so please take a second to search
-for the issue or feature before creating a new one.
-
-All bug fixes should have a ticket. This makes it easy for everyone
-to discuss the code and know if a fix is already in progress for an issue.
-
-
-### 2. Fork & Create a Feature Branch
-
-The next step is to fork Active Admin (if you haven't already done so) and
-create a new git branch based on the feature or issue you're working on. Please
-use a descriptive name for your branch.
-
-For example a great branch name would be (where issue #325 is the ticket you're
-working on):
-
-    $> git checkout -b 325-add-japanese-translations
+A good branch name would be (where issue #325 is the ticket you're working on):
 
+```sh
+git checkout -b 325-add-japanese-translations
+```
 
 ### 3. Get the test suite running
 
-Active Admin is a gem that many people and businesses rely on for managing data
-in their production applications. Bugs are not cool. Although we're not perfect,
-we pride ourselves on writing well tested code. I hope you do too :)
+Install the development dependencies:
 
-Active Admin uses rspec and cucumber for it's test suite.
-
-Make sure you have a recent version of bundler:
-
-    $> gem install bundler
-
-Then install the development the development dependencies:
-
-    $> bundle install
+```sh
+bundle install
+```
 
 Now you should be able to run the entire suite using:
 
-    $> rake test
+```sh
+rake test
+```
 
-`rake test` runs the unit specs, integration specs and cucumber scenarios. The
-test suite will generate a rails application in `spec/rails` to run the tests
-against.
+Which will generate a rails application in `spec/rails` to run the tests against.
 
+If your tests are passing locally but they're failing on Travis, reset your test environment:
 
-### 4. Implement your fix or feature
+```sh
+rm -rf spec/rails && bundle update
+```
 
-At this point, you should be ready to implement your feature!
+### 4. 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
 
 Active Admin is meant to be used by humans, not cucumbers. So make sure to take
-a look at your changes in a browser (preferably a few browsers if you made view
-changes).
+a look at your changes in a browser.
 
-To boot up a test rails application, use the provided script:
+To boot up a test Rails app:
 
-    $> ./script/local server
+```sh
+script/local server
+```
 
-This will generate a rails application at ./test-rails-app with some sane
-defaults and use your local version of Active Admin.
+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 provided `use_rails` script then prepend
+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:
 
-    $> ./script/use_rails 3.1.0
-    $> RAILS=3.1.0 ./script/local server
+```sh
+script/use_rails 4.0.0
+RAILS=4.0.0 script/local server
+```
 
-You should be able to open `http://localhost:3000/admin` and view a test
-environment.
+You should now be able to open <http://localhost:3000/admin> in your browser. You can log in using:
+
+	User: admin@example.com
+	Password: password
 
 If you need to perform any other commands on the test application, use the
-`local` script. For example to boot the rails console:
+`local` script. For example:
 
-    $> ./script/local console
+To boot the rails console:
 
-Or to migrate the database:
+```sh
+script/local console
+```
 
-    $> ./script/local rake db:migrate
+Or to migrate the database:
 
+```sh
+script/local rake db:migrate
+```
 
 ### 6. Run tests against major supported rails versions
 
 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.
 
-    $> rake test:major_supported_rails
+```sh
+rake test:major_supported_rails
+```
 
-This command runs the cukes and specs against a couple of major versions of
-Rails.  We will run this command when we review your pull request, if this
-rake task isn't passing, the pull request will not be merged in.
+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
+### 7. 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. If there were any changes, you
-should rebase your feature branch and make sure that it will merge correctly. If
-there are any merge conflicts, your pull request will not be merged in.
+up to date with Active Admin's master branch:
+
+```sh
+git remote add upstream git@github.com:activeadmin/activeadmin.git
+git checkout master
+git pull upstream master
+```
+
+Then update your feature branch from your local copy of master, and push it!
+
+```sh
+git checkout 325-add-japanese-translations
+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
+
+### 8. 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:
 
-Now push your changes up to your feature branch on GitHub and make a pull request!
-We will pull your changes, run the test suite, review the code and merge it in.
+```sh
+git checkout 325-add-japanese-translations
+git pull --rebase upstream master
+git push -f 325-add-japanese-translations
+```

data/Gemfile

@@ -2,53 +2,53 @@ source 'https://rubygems.org'
 
 gemspec
 
-ACTIVE_ADMIN_PATH = File.dirname(__FILE__) unless defined?(ACTIVE_ADMIN_PATH)
-
-require File.expand_path('spec/support/detect_rails_version', ACTIVE_ADMIN_PATH)
+require File.expand_path 'spec/support/detect_rails_version', File.dirname(__FILE__)
 
 rails_version = detect_rails_version
 gem 'rails', rails_version
-gem 'bourbon'
-
-case rails_version
-when /^3\.0/
-  # Do nothing, bundler should figure it out
-when /^3\.(1|2)/
-  # These are the gems you have to have for Rails 3.1 to be happy
-  gem 'sass-rails'
-  gem 'uglifier'
-  gem "test-unit", "~>3.0" # a rails 3.2 on ruby 2.2 requirement
-else
-  raise "Rails #{rails_version} is not supported yet"
-end
+
+# Optional dependencies
+gem 'cancan'
+gem 'devise'
+gem 'draper'
+gem 'pundit'
+
+# Utility gems used in both development & test environments
+gem 'rake', require: false
+gem 'parallel_tests'
+
+# Debugging
+gem 'pry'                  # Easily debug from your console with `binding.pry`
 
 group :development do
-  gem 'better_errors',     '~> 0.9.0' # Web UI to debug exceptions. Go to /__better_errors to access the latest one
-  gem 'binding_of_caller', '~> 0.7.1' # Retrieve the binding of a method's caller in MRI Ruby >= 1.9.2
-end
+  # Debugging
+  gem 'better_errors'      # Web UI to debug exceptions. Go to /__better_errors to access the latest one
+  gem 'binding_of_caller'  # Retrieve the binding of a method's caller in MRI Ruby >= 1.9.2
 
-group :development, :test do
-  # gem 'haml', '~> 3.1.7',  :require => false
-  gem 'rake', '~> 10.0.2', :require => false
-  gem 'rails-i18n' # Provides default i18n for many languages
-  gem 'rdiscount'  # Markdown implementation (for yard)
-  gem 'sprockets'
-  gem 'yard'
+  # Performance
+  gem 'rack-mini-profiler' # Inline app profiler. See ?pp=help for options.
+  gem 'flamegraph'         # Flamegraph visualiztion: ?pp=flamegraph
+
+  # Documentation
+  gem 'yard'               # Documentation generator
+  gem 'redcarpet'          # Markdown implementation (for yard)
 end
 
 group :test do
-  gem 'cancan'
-  gem 'capybara',        '1.1.2'
-  gem 'coveralls',       '~> 0.6.7', require: false # Test coverage tool: www.coveralls.io
-  gem 'cucumber-rails',  '1.3.0', :require => false
-  gem 'database_cleaner', '<= 1.0.1'
-  gem 'guard-coffeescript'
+  gem 'capybara'
+  gem 'simplecov', require: false # Test coverage generator. Go to /coverage/ after running tests
+  gem 'coveralls', require: false # Test coverage website. Go to https://coveralls.io
+  gem 'cucumber-rails', require: false
+  gem 'database_cleaner'
   gem 'guard-rspec'
   gem 'jasmine'
-  gem 'jslint_on_rails', '~> 1.1.1'
+  gem 'jslint_on_rails'
   gem 'launchy'
-  gem 'parallel_tests'
-  gem 'rspec-rails',     '~> 2.9.0'
+  gem 'rails-i18n' # Provides default i18n for many languages
+  gem 'rspec'
+  gem 'rspec-rails', '~> 3.1.0'
+  gem 'i18n-spec'
   gem 'shoulda-matchers'
   gem 'sqlite3'
+  gem 'poltergeist'
 end

data/Guardfile

@@ -4,4 +4,5 @@ guard 'rspec', :all_on_start => false, :version => 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/active_admin/(.+)\.rb$})     { |m| "spec/unit/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec/" }
+  watch('spec/rails_helper.rb')  { "spec/" }
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Greg Bell, VersaPay Corporation
+Copyright (c) Greg Bell, VersaPay Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,98 @@
+# Active Admin
+
+Active Admin 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)
+
+## 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'
+```
+
+Or you can using rubygems:
+```ruby
+gem 'activeadmin', '~> 1.0.0.pre1'
+```
+
+*Keep in mind that during the time where we use `pre`-release label, things can break in each release!*
+
+### 0.6.x
+
+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:
+
+```ruby
+gem 'activeadmin', github: 'activeadmin', branch: '0-6-stable'
+```
+
+## Documentation
+
+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).
+
+## Links
+
+* 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>
+
+## 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.
+
+## Getting started
+
+Check out [the docs](https://github.com/activeadmin/activeadmin/blob/master/docs/0-installation.md)!
+
+## Need help?
+
+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).
+
+## Dependencies
+
+We try not to reinvent the wheel, so Active Admin is built with other open source projects:
+
+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
+
+[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
+[Ransack]: https://github.com/activerecord-hackery/ransack

data/Rakefile

@@ -1,11 +1,11 @@
-require "bundler"
+require 'bundler'
 require 'rake'
 Bundler.setup
 Bundler::GemHelper.install_tasks
 
 def cmd(command)
   puts command
-  raise unless system command
+  fail unless system command
 end
 
 require File.expand_path('../spec/support/detect_rails_version', __FILE__)
@@ -13,13 +13,21 @@ require File.expand_path('../spec/support/detect_rails_version', __FILE__)
 # Import all our rake tasks
 FileList['tasks/**/*.rake'].each { |task| import task }
 
-task :default => :test
+task default: :test
 
 begin
   require 'jasmine'
   load 'jasmine/tasks/jasmine.rake'
 rescue LoadError
   task :jasmine do
-    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+    abort 'Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine'
   end
 end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+
+  ARGV.clear
+  IRB.start
+end