Skip to content

luisalima/outdatedbrowser_rails

Repository files navigation

OutdatedbrowserRails

This project bundles the excellent Burocratik's Outdated Browser detector for use with the rails 4+ asset pipeline.

Gem Version

About

The version numbers of this gem follow the versioning of Outdated Browser, and the gem follows the feature/languages gem, which includes translations for several languages. The gem uses I18n.locale to select the correct locale, and falls back to en if the selected locale does not exist.

Installation

Add this line to your application's Gemfile:

gem 'outdatedbrowser_rails'

Usage

1. Include Outdated Browser assets

Add this line to your application.js:

//= require outdatedbrowser/outdatedBrowser

Add this line to your application.css || application.scss:

//= require outdatedbrowser/outdatedBrowser

2. Require Outdated Browser

In the view where you want to use this, add:

<%= render 'outdatedbrowser/outdatedbrowser' %>

At the bottom of the body (make sure it's included after application.js), add:

<%= javascript_include_tag 'outdatedbrowser/require_outdatedbrowser' %>

Testing the integration in your app

  • Of course, ideally use an outdated browser to test.
  • With an up-to-date browser:
  • In the view where you included the partial, check that #outdated is present.
  • See how it looks: $('#outdated').show()

Contributing

Feel free to open an issue if you find something that could be improved.

Here are a couple of things worth noting:

  • This is a mountable rails engine tested with rspec and capybara. For more info or a good reference to make your own, see this good tutorial.
  • The reference to outdatedbrowser is a git submodule. For a good reference on how to update git submodules, see this.
  • The rake task rake generate:assets copies the assets from the vendor/outdated-browser folder (which is a git submodule) to the engine app folder.
  • The rake task clean cleans the copied assets.
  • To run tests, use rspec spec.

Finally, to contribute:

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Run tests using rspec spec, and make sure they are green!
  4. Add tests to spec/features, if necessary.
  5. Commit your changes (git commit -am 'Add some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request