Cosme
Cosme is a simple solution to customize views of any template engine in your Ruby on Rails application.
Installation
Add this line to your application's Gemfile:
gem 'cosme'
And then execute:
$ bundle
Or install it yourself as:
$ gem install cosme
Usage
- Require a script in your
app/assets/javascripts/application.coffee:
#= require cosme
- Create a cosmetic file into
app/cosmetics.
Example
Inserts html to all elements of .example:
# app/cosmetics/after_example.rb
Cosme.define(
target: '.example',
action: :after
)
<%# app/cosmetics/after_example.html.erb %>
<h2>After Example</h2>
<%# app/views/layouts/application.html.erb %>
<html>
<head>
<title>Example</title>
<%= stylesheet_link_tag 'application', media: 'all' %>
<%= javascript_include_tag 'application'%>
</head>
<body>
<div class="example">
<h1>Example</h1>
</div>
</body>
</html>
The result of the above:
<div class="example">
<h1>Example</h1>
</div>
<h2>After Example</h2>
Troubleshooting
If the cosmetic does not work, please call Cosme.disable_auto_cosmeticize! and the folloing helper method in your view file.
<%= cosmeticize %>
Development
After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/appirits/cosme.
License
The gem is available as open source under the terms of the MIT License.