phoet / partially_useful

:bookmark_tabs: :eyes: Helps identifying partials in verbose HTML source code.

PartiallyUseful

HTML source code is very verbose and can be a pain in the ass to find a specific part on big pages.

Finding the origin of a piece of HTML in the Rails app/views directory can be tedious and error prone.

Adding this gem to your Rails application adds HTML comments at development time, so it's easy to find the right partials.

<!-- start rendering 'some_partial' with locals '[:all, :assigned, :locals]'-->
<div class="hello">
    <div class="world">
      [...]
    </div>
</div>
<!-- end rendering 'some_partial' with locals '[:all, :assigned, :locals]'-->

Installation

Add this line to your application's Gemfile:

gem 'partially_useful', group: 'development'

Usage

The plugin is enabled by default, but you can disable it in your Rails configuration:

# config/environments/development.rb
config.partially_useful = false

Caveats

HTML comments might subtly break your application when partials are used out of the usual HTML rendering context (JS, CSS etc).

If you run into any problems, make sure to disable the gem and restart your Rails server.

Supported Ruby and Rails versions

Version 6.0.x has support for Rails 6.0.x. Version 5.1.0 has support for Rails 5.x and Ruby 2.x. Older Rails and Ruby versions are supported by the 0.x releases.

Contributing

1. Fork it ( https://github.com/phoet/partially_useful/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

License

See LICENSE.md.

Changelog

See CHANGELOG.md.

partially_useful's Issues

Clarification about the minimum Ruby version

Hi,

I've been using something way more manual than this for a long time and I like what you've done here. It's very useful. Thanks

You seem to use Module#prepend on ActionView::PartialRenderer which has been introduced by Ruby 2.0.
If I'm not wrong about this, it might be a good idea to state this requirement explicitly in the README and in the gemspec.