@@ -12,7 +12,7 @@ Some cool things about Smurf, which also allude to the reasons I wrote it: * Other than installing it, you don't need to do anything * It just gets out of your way -Smurf will work with any version of Rails `2.x`; including Rails `2.2.2`. +Smurf will work with any version of Rails `2.x`; including Rails `2.3.4` and `2.1.2`. ### JSmin @@ -32,7 +32,13 @@ The following are the rules I applied, gathered from various perusals around the ## Installation - ./script/plugin install git://github.com/thumblemonks/smurf.git +I like gems. So, I suggest you install Smurf as gem. It's pretty simple, assuming you have added Gem Cutter to your list of gem sources. If you have not, do this: + + sudo gem sources -a http://gemcutter.org + +Then, install Smurf as a gem: + + sudo gem install smurf Then, wherever you define `javascript_include_tag` or `stylesheet_link_tag`, make sure to add the standard `:cache => true` or `:cache => 'some_bundle'` options. @@ -40,6 +46,14 @@ Also make sure to at least have this setting in your production.rb: config.action_controller.perform_caching = true +#### As a plugin + +If you really feel like it, go ahead and install Smurf as a plugin. This should do it: + + ./script/plugin install git://github.com/thumblemonks/smurf.git + +Then do the other stuff for setting up Smurf in your Rails environment. + ### Small suggestion [bcarpenter](http://github.com/bcarpenter) reminded all of us that Rails will generate real files if you set `config.action_controller.perform_caching` to `true`. If you happen to do this while developing your fantastic Rails app you may also accidentally commit them to your development repository. This is not what you want as it can send you and your awesome developer friends down the wrong rabbit hole ... and then when you figure out the problem you may be understandably and misguidedly pissed at Smurf :) @@ -50,13 +64,13 @@ Also make sure to at least have this setting in your production.rb: ## Testing -If you want to test Smurf and you don't want to test with the latest version of Rails, then do something like the following (using 2.2.2 as an example): +If you want to test Smurf and you don't want to test with the latest version of Rails, then do something like the following (using 2.3.4 as an example): - rake RAILS_GEM_VERSION=2.2.2 + rake RAILS_GEM_VERSION=2.3.4 This is the mechanism I used for testing that Smurf works for all versions: - rake && rake RAILS_GEM_VERSION=2.2.2 + rake && rake RAILS_GEM_VERSION=2.2.2 && rake RAILS_GEM_VERSION=2.1.2 ## Meta README.markdown @@ -2,7 +2,7 @@ Gem::Specification.new do |s| s.name = "smurf" s.summary = "Rails plugin to automatically minify JS and CSS when their bundles get cached" s.description = "Rails plugin to automatically minify JS and CSS when their bundles get cached. Send in those patches!" - s.version = "1.0.0" + s.version = "1.0.1" s.authors = ["Justin Knowlden"] s.email = %w[gus@thumblemonks.com] s.homepage = "http://github.com/thumblemonks/smurf" @@ -27,7 +27,6 @@ Gem::Specification.new do |s| s.test_files = %w[ test/rails/app/controllers/application.rb test/rails/config/boot.rb - test/rails/config/database.yml test/rails/config/environment.rb test/rails/config/environments/test.rb test/rails/config/routes.rb smurf.gemspec 62eeaeea1739fe7a0c6695c8ecce0bf1edfc5c59 Justin Knowlden gus@gusg.us http://github.com/thumblemonks/smurf/commit/6f94413731ed74af842b575a7d770485632cec1b 6f94413731ed74af842b575a7d770485632cec1b 2009-10-10T00:22:54-07:00 2009-10-10T00:21:33-07:00 Gem bump to 1.0.1 * Applied a fix from josecosta for making sure Rails.version is actually defined * Updated README to say something about installation as a gem from Gem Cutter 968116532e20b3deb616b1b38050cce65900b786 Justin Knowlden gus@gusg.us