uswds-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e314ae13b7f9d59527fe05e405a066e0ba0366fd
+  data.tar.gz: ba6bbb25fa3cba7206c81a9e9b643d9075c437d4
+SHA512:
+  metadata.gz: 473fe9d83db1bb136ef628f282e2a83dbc78e07b32f8779ab000bb871397ff09a1534638c2696a2188c6a85ef43651b63e7d94435734e2a298f4621c60eedce0
+  data.tar.gz: 5b1d4da9606823003a3c98328ad8f3eb51885f7ed3293ede368f47c4529206b0b553f71ba0b7398d277eff79eb799809377279b1df5b5ecfa065549b1695cd98

data/.codeclimate.yml

@@ -0,0 +1,17 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+        - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - lib/
+exclude_paths:
+  - spec/
+  - vendor/

data/.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig is awesome: http://EditorConfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true
+
+[*.md]
+indent_size = 4
+indent_style = tab

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+# Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--require rails_helper

data/.rubocop

@@ -0,0 +1,3 @@
+--display-cop-names
+--display-style-guide
+--extra-details

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+
+FileName:
+  Exclude:
+    - 'lib/uswds-rails.rb'
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.simplecov

@@ -0,0 +1,13 @@
+require 'simplecov-console'
+
+formatters = [SimpleCov::Formatter::HTMLFormatter]
+
+if RSpec.configuration.files_to_run.length > 1
+  formatters << SimpleCov::Formatter::Console
+end
+
+SimpleCov.start do
+  add_filter 'spec/dummy'
+
+  formatter SimpleCov::Formatter::MultiFormatter.new(formatters)
+end

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+before_install:
+  - gem update --system
+  - gem update bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_success:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+notifications:
+  email: false
+  slack: sixtwothree:yATLmjTW15443qR7jbCWr3RO

data/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to uswds-rails
+
+Anyone is welcome to contribute code changes and additions to this project. If you'd like your changes merged into the master branch, please read the following document before opening a [pull request][pulls].
+
+There are several ways in which you can help improve this project:
+
+1. Fix an existing [issue][issues] and submit a [pull request][pulls].
+1. Review open [pull requests][pulls].
+1. Report a new [issue][issues]. _Only do this after you've made sure the behavior or problem you're observing isn't already documented in an open issue._
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Making Changes](#making-changes)
+- [Code Style](#code-style)
+
+## Getting Started
+
+uswds-rails is written in [Ruby](https://www.ruby-lang.org/en/) (version 2.4.1) and development dependencies are managed using the [Bundler](http://bundler.io/) gem. [Travis CI builds](https://travis-ci.org/jgarber623/uswds-rails) use Ruby 2.2.7, 2.3.4, and 2.4.1.
+
+I manage Ruby versions with [rbenv](https://github.com/rbenv/rbenv). I'd recommend you do the same or use a similar Ruby version manager ([chruby](https://github.com/postmodern/chruby/) or [RVM](https://rvm.io/) come to mind). Once you've installed Ruby 2.4.1 using your method of choice, install the project's gems by running:
+
+```sh
+bundle install
+```
+
+…from the root of the project.
+
+## Making Changes
+
+1. Fork and clone the project's repo.
+1. Install development dependencies as outlined above.
+1. Create a feature branch for the code changes you're looking to make: `git checkout -b your-descriptive-branch-name origin/master`.
+1. _Write some code!_
+1. Build (`bundle exec rake build`) and install (`bundle exec rake install`) your updated code.
+1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bin/rake spec`.
+1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://chris.beams.io/posts/git-commit/) for tips on writing useful Git commit messages.)_
+1. Push the branch to your fork: `git push -u origin your-descriptive-branch-name`.
+1. Create a new pull request and we'll review your changes.
+
+## Code Style
+
+Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org/) syntax. There are [plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. It is recommended that you install the EditorConfig plugin for your editor of choice.
+
+Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.
+
+[gemfile]: https://github.com/jgarber623/uswds-rails/blob/master/Gemfile
+[issues]: https://github.com/jgarber623/uswds-rails/issues
+[license]: https://github.com/jgarber623/uswds-rails/blob/master/LICENSE.md
+[pulls]: https://github.com/jgarber623/uswds-rails/pulls

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uswds-rails.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,27 @@
+# License Information
+
+uswds-rails includes portions of the [U.S. Web Design Standards](https://github.com/18F/web-design-standards) released under a [CC0 1.0 Universal Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/). Portions of the U.S. Web Design Standards are not in the public domain. Additional licensing information can be found in the project's [LICENSE.md](https://github.com/18F/web-design-standards/blob/develop/LICENSE.md).
+
+The remainder of uswds-rails is licensed under the [MIT License](https://opensource.org/licenses/MIT), the full text of which is included below.
+
+```
+Copyright 2017 Jason Garber
+
+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, sublicense, 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 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 NONINFRINGEMENT. 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.
+```

data/README.md

@@ -0,0 +1,64 @@
+# uswds-rails
+
+A Ruby gem for integrating the [U.S. Web Design Standards](https://github.com/18F/web-design-standards) into a [Ruby on Rails](http://rubyonrails.org) application.
+
+[![Gem Version](https://img.shields.io/gem/v/uswds-rails.svg?label=gem%20version)](https://rubygems.org/gems/uswds-rails)
+[![Downloads](https://img.shields.io/gem/dt/uswds-rails.svg)](https://rubygems.org/gems/uswds-rails)
+[![Build Status](https://img.shields.io/travis/jgarber623/uswds-rails/master.svg?label=build%20status)](https://travis-ci.org/jgarber623/uswds-rails)
+[![Code Climate](https://img.shields.io/codeclimate/github/jgarber623/uswds-rails.svg)](https://codeclimate.com/github/jgarber623/uswds-rails)
+[![Coverage](https://img.shields.io/codeclimate/coverage/github/jgarber623/uswds-rails.svg)](https://codeclimate.com/github/jgarber623/uswds-rails/coverage)
+
+## Getting Started
+
+Before installing and using uswds-rails, you'll want to have Ruby 2.2.7 (or newer) installed on your computer. There are plenty of ways to go about this, but my preference is [rbenv](https://github.com/sstephenson/rbenv). If you're developing on a Mac and using [Homebrew](http://brew.sh/), installing rbenv is [super easy](https://github.com/sstephenson/rbenv#homebrew-on-mac-os-x).
+
+uswds-rails _might_ work with other versions of Ruby, but it's developed in 2.4.1 and automatically tested against 2.2.7 and 2.3.4 by [Travis CI](https://travis-ci.org/jgarber623/uswds-rails).
+
+## Installation
+
+Add uswds-rails to your Ruby on Rails project's Gemfile:
+
+```rb
+ruby '2.4.1'
+
+source 'https://rubygems.org' do
+  gem 'rails', '~> 5.1'
+  gem 'uswds-rails'
+end
+```
+
+Run `bundle install` to install uswds-rails and its dependencies.
+
+## Usage
+
+uswds-rails makes available to your Rails application the fonts, images, JavaScript files, and stylesheets from the U.S. Web Design Standards. Including the files varies depending on type.
+
+The most basic integration looks like:
+
+```scss
+// In `app/assets/stylesheets/application.scss`
+@import "uswds/uswds";
+```
+
+```js
+// In `app/assets/javascripts/application.js`
+//= require "uswds/uswds";
+```
+
+Adding those lines to your project's `application.scss` and `application.js` will include _everything_ from the U.S. Web Design Standards (fonts, JavaScript, and stylesheets).
+
+Don't want to include the entire stylesheet in your project? Not to worry! You may include individual SCSS files by using uswds-rails' [`app/assets/stylesheets/uswds/uswds.scss`](https://github.com/jgarber623/uswds-rails/blob/master/app/assets/stylesheets/uswds/uswds.scss) as a guide.
+
+## Contributing
+
+For details on setting up your development environment and contributing to this project, see [CONTRIBUTING.md](https://github.com/jgarber623/uswds-rails/blob/master/CONTRIBUTING.md).
+
+## Acknowledgments
+
+This project woudn't exist without the [18F](https://github.com/18F) team's hard work on the [U.S. Web Design Standards](https://github.com/18F/web-design-standards).
+
+uswds-rails is written and maintained by [Jason Garber](https://github.com/jgarber623).
+
+## License
+
+uswds-rails is freely available under the [MIT License](https://opensource.org/licenses/MIT). Portions of the project contain code released under different licenses. See [LICENSE.md](https://github.com/jgarber623/uswds-rails/blob/master/LICENSE.md) for additional licensing information.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
+
+task default: :spec

data/app/assets/stylesheets/uswds/components/_accordions.scss

@@ -0,0 +1,150 @@
+// Variables
+
+$accordion-border: 3px solid $color-gray-lightest;
+
+// Accordion Styles
+
+@mixin accordion-list-styles {
+  @include unstyled-list;
+  color: $color-base;
+  margin: 0;
+  padding: 0;
+  width: 100%;
+}
+
+@mixin accordion-list-item-styles {
+  background-color: $color-gray-lightest;
+  font-family: $font-sans;
+  list-style: none;
+  margin-bottom: 6px;
+  width: 100%;
+}
+
+// scss-lint:disable PropertyCount
+@mixin accordion-button-styles {
+  @include button-unstyled;
+  background-color: $color-gray-lightest;
+  background-image: asset-url('#{$image-path}/minus.png');
+  background-image: asset-url('#{$image-path}/minus.svg');
+  background-position: right 3rem center;
+  background-repeat: no-repeat;
+  background-size: 13px;
+  color: $color-base;
+  cursor: pointer;
+  display: inline-block;
+  font-family: $font-sans;
+  font-weight: $font-bold;
+  margin: 0;
+  padding: 1.5rem 5.5rem 1.5rem 3rem;
+  width: 100%;
+
+  &:focus {
+    box-shadow: $focus-shadow;
+  }
+
+  &:hover {
+    background-color: $color-gray-lighter;
+    color: $color-base;
+  }
+
+  h1,
+  h2,
+  h3,
+  h4,
+  h5,
+  h6 {
+    margin: 0;
+  }
+}
+// scss-lint:enable PropertyCount
+
+@mixin accordion-button-unopened-styles {
+  background-image: asset-url('#{$image-path}/plus.png');
+  background-image: asset-url('#{$image-path}/plus.svg');
+  background-repeat: no-repeat;
+  background-size: 1.3rem;
+}
+
+@mixin accordion-nested-list {
+  > ul li ul {
+    list-style: disc;
+    > li > ul {
+      list-style: circle;
+      > li > ul {
+        list-style: square;
+      }
+    }
+  }
+}
+
+.usa-accordion,
+.usa-accordion-bordered {
+  @include accordion-list-styles;
+  @include accordion-nested-list;
+
+  + .usa-accordion,
+  + .usa-accordion-bordered {
+    margin-top: 1rem;
+  }
+
+  // TODO deprecated ruleset based on old accordion.
+  > ul {
+    @include accordion-list-styles;
+
+    // TODO deprecated ruleset based on old accordion.
+    > li {
+      @include accordion-list-item-styles;
+    }
+
+    // TODO deprecated ruleset based on old accordion.
+    button {
+      @include accordion-button-styles;
+    }
+
+    // TODO deprecated ruleset based on old accordion.
+    [aria-expanded=false] {
+      @include accordion-button-unopened-styles;
+    }
+  }
+
+  > li {
+    @include accordion-list-item-styles;
+  }
+
+}
+
+.usa-accordion-bordered {
+  .usa-accordion-content {
+    border-bottom: $accordion-border;
+    border-left: $accordion-border;
+    border-right: $accordion-border;
+  }
+}
+
+.usa-accordion-content {
+  background-color: $color-white;
+  overflow: auto;
+  padding: 3rem;
+
+  > *:first-child {
+    margin-top: 0;
+  }
+
+  > *:last-child {
+    margin-bottom: 0;
+  }
+
+  &:not([aria-hidden]) {
+    @include sr-only();
+  }
+
+  @include accessibly-hidden();
+}
+
+.usa-accordion-button {
+  @include accordion-button-styles;
+}
+
+.usa-accordion-button[aria-expanded=false] {
+  @include accordion-button-unopened-styles;
+}