Va_Common

This includes generation of header and footer, as well as the assets for vets.gov, such as javascript, scss, images, fonts.

Installation

Add this line to your application's Gemfile:

gem 'va_common'

And then execute:

$ bundle

Or install it yourself as:

$ gem install va_common

Usage

For the stylesheets, include this in the application.css file

*= require va_common_main

For the js, include this in the application.js file

//= require va_common_main

Your primary layout (likely application.html.erb) should have a block that looks something like this:

<%= render 'va_common/main' %>

You may also include va_common/header and va_common/footer separately.

IMPORTANT: Rails must be restarted after installing this gem to ensure the search paths for partials are found.

Special IE <3

To get around the special selector limits of IE9, there is a gem called css_splitter included. To make it go:

Add this to the config/initializers/assets.rb file

Rails.application.config.assets.precompile += %w( application_split2.css)

Add this to views/layouts/application.html.rb in the head tag

<%= split_stylesheet_link_tag "application", :media => "all" %>

<!--[if lte IE 9]>
    <link href="/stylesheets/application_split2.css" media="all" rel="stylesheet" type="text/css" />
<![endif]-->

Create a new file called application_split2.css to the same directory as application.css.scss, and put this in it

/*
 *= require 'application'
 */ 

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake false 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.

Releasing

You will need to be added as an owner of va_common to release a new version. If you have never released a gem before, go to rubygems.org and create an account. Then from the command line run curl -u qrush https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials

To release a new version, update the version number in lib/va_common/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/[USERNAME]/va_common. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.