jlecour / ck_fu forked from r38y/ck_fu

Adds a development toolbar to your site that makes it easy to tell the difference between development, staging, and production.

This URL has Read+Write access

ck_fu /
name age
history
message
file .gitignore Sun Feb 08 21:46:44 -0800 2009 Add specs to make sure it behaves appropriately [Randy Schmidt]
file .gitmodules Tue Feb 17 20:17:07 -0800 2009 website -> gh-pages folder [Randy Schmidt]
file MIT-LICENSE Sat Apr 19 12:18:24 -0700 2008 Adding umlatte LLC to the license file [cbartlett]
file README Sun Feb 08 21:55:58 -0800 2009 Update readme [Randy Schmidt]
file Rakefile Sun Feb 08 21:46:44 -0800 2009 Add specs to make sure it behaves appropriately [Randy Schmidt]
file init.rb Loading commit data...
file install.rb
directory lib/
directory public/
directory spec/
directory tasks/ Sat Apr 19 09:09:12 -0700 2008 First pass at making it work [Randy Schmidt]
file uninstall.rb
submodule website - 11ca0ed Tue Feb 17 20:17:07 -0800 2009 website -> gh-pages folder [Randy Schmidt]
README
CkFu
====

Where does the name ck_fu come from? It's a play on attachment_fu and I think curse words are funny.

This will put a bar across the top of your screen (except in production unless :if is specified and true) that shows the 
environment, 
databases, revision, etc. Why do we need something like this? because the development and staging sites often look 
identical to the 
production site. This makes it easy to tell the difference between the sites at a glance.

Example
=======

* Run rake ck_fu:copy_styles
* Add ck_fu.css to your list of stylesheets
* Add the following directly below your <body> tag
<%= ck_fu %>

More Advanced Usage
===================

* ck_fu (default) will not show up in production
<div class="test" id="ck_fu">Env: Test &sect; Current DB: myapp_dev</div>

* If RAILS_ROOT/REVISION exists (created by capistrano when deploying) (can suppress with :revision => false)
<div class="test" id="ck_fu">Env: Test &sect; Current DB: myapp_dev &sect; Revision: <rev></div>

* If RAILS_ROOT/DATE exists (can suppress with :date => false)
<div class="test" id="ck_fu">Env: Test &sect; Current DB: myapp_dev &sect; Deployed: <date></div>
To make this exist on the server, add something like the following to deploy.rb:
task :after_symlink, :roles => :web do
  run "date > #{current_release}/DATE"
end

* Arbitrary links
ck_fu(:links => [['Public site', root_path]])
<div class="test" id="ck_fu">Env: Test &sect; Current DB: myapp_dev &sect; <a href="/">Public site</a></div>

* Display based on some condition like the current_user is an admin
ck_fu(:if => current_user.try(:admin?)) - will display in production as well if the user is an admin.

For more information and screenshots, visit http://ck_fu.me

Copyright (c) 2008 umlatte LLC, released under the MIT license