Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

add generator for rails 3.0.x or no asset pipeline

  • Loading branch information...
commit efbc7f131b307dd099ac9ba4ba8b4e9bfb4defc9 1 parent 34f2544
@phlipper authored
View
51 README.md
@@ -1,13 +1,15 @@
# Sugar-rails
-[Sugar](http://sugarjs.com/), tastefully bundled for the Rails 3.1 asset pipeline. Sweet!
+[Sugar](http://sugarjs.com/), tastefully bundled for the Rails 3.0 and up. Sweet!
-## Usage
+## Rails 3.1+
-This gem vendors Sugar 1.2 for Rails 3.1 and greater. The files will be added to the asset pipeline and available for you to use.
+For Rails 3.1 and greater, the files will be added to the asset pipeline and available for you to use.
-To enable, add the following line to the file `app/assets/javascripts/application.js` (or other [sprockets](https://github.com/sstephenson/sprockets) manifest):
+To enable:
+
+* Add the following line to the file `app/assets/javascripts/application.js` (or other [sprockets](https://github.com/sstephenson/sprockets) manifest):
``` javascript
//= require sugar
@@ -22,21 +24,46 @@ To enable, add the following line to the file `app/assets/javascripts/applicatio
Enjoy!
+## Rails 3.0
+
+This gem adds a single generator to Rails 3, `sugar:install`. Running the generator will install the JavaScript file necessary to use Sugar.
+
+### Installation
+
+* Add `sugar-rails` to your Gemfile
+* Run `bundle`
+* Invoke the generator: `rails generate sugar:install`
+* Add the following to your layout or view files:
+
+```erb
+<%= javascript_include_tag "sugar" %>
+```
+
+You're done!
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
## License
**sugar-rails**
-Copyright (c) 2011-2012, Phil Cohen github@phlippers.net All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sub-license, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-The above copyright notice, and every other copyright notice found in this software, and all the attributions in every file, and this permission notice shall be included in all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 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.
+* Freely distributable and licensed under the [MIT license](http://phlipper.mit-license.org/2011-2012/license.html).
+* Copyright (c) 2011-2012 Phil Cohen (github@phlippers.net) [![endorse](http://api.coderwall.com/phlipper/endorsecount.png)](http://coderwall.com/phlipper)
+* http://phlippers.net/
**Sugar JS**
-* Freely distributable and licensed under the MIT-style license.
-* Copyright (c) 2012 Andrew Plummer
-* http://sugarjs.com/
+* Freely distributable and licensed under the MIT-style license.
+* Copyright (c) 2012 Andrew Plummer
+* http://sugarjs.com/
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sub-license, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice, and every other copyright notice found in this software, and all the attributions in every file, and this permission notice shall be included in all copies or substantial portions of the Software.
View
35 lib/generators/sugar/install/install_generator.rb
@@ -0,0 +1,35 @@
+require "rails"
+
+# Supply generator for Rails 3.0.x or if asset pipeline is not enabled
+if ::Rails.version < "3.1" || !::Rails.application.config.assets.enabled
+ module Sugar
+ module Generators
+ class InstallGenerator < ::Rails::Generators::Base
+ desc "This generator installs SugarJS #{Sugar::Rails::SUGARJS_VERSION}"
+ source_root File.expand_path("../../../../../vendor/assets", __FILE__)
+
+ def copy_javascript
+ say_status("copying", "Sugar JS", :green)
+ copy_file "javascripts/sugar.js", "public/javascripts/sugar.js"
+ end
+ end
+ end
+ end
+else
+ module Sugar
+ module Generators
+ class InstallGenerator < ::Rails::Generators::Base
+ desc "Just show instructions so people will know what to do when mistakenly using generator for Rails 3.1 apps"
+
+ def do_nothing
+ say_status("deprecated", "You are using Rails 3.1 with the asset pipeline enabled, so this generator is not needed.")
+ say_status("", "The necessary files are already in your asset pipeline.")
+ say_status("", "Just add `//= require sugar` to your app/assets/javascripts/application.js")
+ say_status("", "If you upgraded your app from Rails 3.0 and still have sugar.js in your public assets folders, be sure to remove them.")
+ say_status("", "If you do not want the asset pipeline enabled, you may turn it off in application.rb and re-run this generator.")
+ # ok, nothing
+ end
+ end
+ end
+ end
+end
View
1  lib/sugar/rails/version.rb
@@ -1,5 +1,6 @@
module Sugar
module Rails
VERSION = "1.2.2"
+ SUGARJS_VERSION = "1.2.3"
end
end
Please sign in to comment.
Something went wrong with that request. Please try again.