refills 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8f585461e3904428122b7557bcf892e441ee2a2
-  data.tar.gz: da61d3234fc77682851be8510b525fdd8ae0dc6c
+  metadata.gz: 96c9acd760ddbd40d94c82ebd9ace42b36a070a7
+  data.tar.gz: b525e5d9fd76bc75ae908f964bf871cb59e562ac
 SHA512:
-  metadata.gz: d5cd76b20751322f29bebb84daa095873c22c339d78cb54a0c7c8a784c2c729e82078b365b5144243c720bc0c9034bd60c4b30a17d77e7ebaa3faa2dcc74a26a
-  data.tar.gz: 609b48e8ab4feda91dbd524e6addaeeccbede4f0beb2b171c28b1f595be9aefbaeb8de7692782c211c82cb2b159277bb5c90ca43c2d0d8b4f51463569ef4561c
+  metadata.gz: 3054c91575d1c057b5e9b856f36e4242a18fadf0fc56f75767c6f6b1da4b22b28b6d5095a402083841da3dbce596ecf7f349c8b3ce56cac4027b1ac0d70adc9e
+  data.tar.gz: 00706dda998cc594b59f7e638f97176fa731c404e711cda98de44adb1cfbe0ba3fa3ca8c39ade8e253295836d416b1a55c65f4ecfaf40fff0de7b35238ae8cb9

data/.buildpacks

@@ -0,0 +1,2 @@
+https://github.com/heroku/heroku-buildpack-ruby.git
+https://github.com/hashicorp/heroku-buildpack-middleman.git

data/.gitignore

@@ -1,17 +1,8 @@
-# See http://help.github.com/ignore-files/ for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-# git config --global core.excludesfile ~/.gitignore_global
-
-# Ignore bundler config
-/.bundle
-
-# Ignore the build directory
-/build
-
-# Ignore Sass' cache
-/.sass-cache
-
-# Ignore .DS_store file
+.bundle
 .DS_Store
+.sass-cache
+build
+Gemfile.lock
+pkg
+tmp/
+node_modules/

data/.hound.yml

@@ -0,0 +1,6 @@
+scss:
+  enabled: true
+java_script:
+  enabled: true
+ruby:
+  enabled: true

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.scss-lint.yml

@@ -0,0 +1,173 @@
+linters:
+  BangFormat:
+    enabled: true
+    space_before_bang: true
+    space_after_bang: false
+
+  BorderZero:
+    enabled: false
+
+  ColorKeyword:
+    enabled: true
+    severity: warning
+
+  Comment:
+    enabled: true
+
+  DebugStatement:
+    enabled: true
+
+  DeclarationOrder:
+    enabled: true
+
+  DuplicateProperty:
+    enabled: true
+
+  ElsePlacement:
+    enabled: true
+    style: same_line
+
+  EmptyLineBetweenBlocks:
+    enabled: true
+    ignore_single_line_blocks: true
+
+  EmptyRule:
+    enabled: true
+
+  FinalNewline:
+    enabled: true
+    present: true
+
+  HexLength:
+    enabled: false
+    style: short
+
+  HexNotation:
+    enabled: true
+    style: lowercase
+
+  HexValidation:
+    enabled: true
+
+  IdWithExtraneousSelector:
+    enabled: true
+
+  ImportPath:
+    enabled: true
+    leading_underscore: false
+    filename_extension: false
+
+  Indentation:
+    enabled: true
+    character: space
+    width: 2
+
+  LeadingZero:
+    enabled: true
+    style: include_zero
+
+  MergeableSelector:
+    enabled: true
+    force_nesting: true
+
+  NameFormat:
+    enabled: true
+    convention: hyphenated_lowercase
+
+  NestingDepth:
+    enabled: true
+    max_depth: 4
+    severity: warning
+
+  PlaceholderInExtend:
+    enabled: false
+
+  PropertySortOrder:
+    enabled: true
+    ignore_unspecified: false
+    severity: warning
+
+  PropertySpelling:
+    enabled: true
+    extra_properties: []
+
+  QualifyingElement:
+    enabled: true
+    allow_with_attribute: false
+    allow_with_class: false
+    allow_with_id: false
+    severity: warning
+
+  SelectorDepth:
+    enabled: true
+    max_depth: 2
+    severity: warning
+
+  SelectorFormat:
+    enabled: true
+    convention: hyphenated_lowercase
+
+  Shorthand:
+    enabled: true
+    severity: warning
+
+  SingleLinePerProperty:
+    enabled: true
+    allow_single_line_rule_sets: true
+
+  SingleLinePerSelector:
+    enabled: true
+
+  SpaceAfterComma:
+    enabled: true
+
+  SpaceAfterPropertyColon:
+    enabled: true
+    style: one_space
+
+  SpaceAfterPropertyName:
+    enabled: true
+
+  SpaceBeforeBrace:
+    enabled: true
+    style: space
+    allow_single_line_padding: false
+
+  SpaceBetweenParens:
+    enabled: true
+    spaces: 0
+
+  StringQuotes:
+    enabled: true
+    style: double_quotes
+
+  TrailingSemicolon:
+    enabled: true
+
+  TrailingZero:
+    enabled: false
+
+  UnnecessaryMantissa:
+    enabled: true
+
+  UnnecessaryParentReference:
+    enabled: true
+
+  UrlFormat:
+    enabled: true
+
+  UrlQuotes:
+    enabled: true
+
+  VendorPrefixes:
+    enabled: true
+    identifier_list: bourbon
+    include: []
+    exclude: []
+
+  ZeroUnit:
+    enabled: true
+    severity: warning
+
+  Compass::*:
+    enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- 1.9.3
+- rbx-2
+- 2.0.0
+- 2.1
+script: bundle exec rake
+sudo: false

data/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing
+
+You are more than welcome to submit any component or pattern you can’t find in
+the library, or feel free to send requests for content you’d like to see. When
+submitting a pull request, please think of these style guides:
+
+## HTML.erb
+
+- Make sure that each component or pattern is independent of other components
+  and patterns in the Refills library. There should be no dependencies between
+  different components and patterns.
+
+## Sass
+
+All components and patterns should be fully responsive and follow the [Neat
+examples](http://neat.bourbon.io/examples).
+
+Avoid more than 2 levels of nesting for clarity and legibility of code.
+
+Try to use as little styling as possible. Use the styles that come with Bitters
+to keep everything consistent.
+
+Put media queries inline, don’t separate them since that will create a lot of
+repetitions of class names. If needed, for the sake of clarity, create a
+specific variable for a media query if a certain breakpoint changes the
+component/pattern drastically:
+
+```scss
+$tab-mode: $medium-screen;
+
+@include media($tab-mode) { // $tab-mode is the same as $medium-screen here
+  border-radius: 0;
+}
+```
+
+Create variables for any color or size that might appear in a refill,
+especially if it appears more than once in the component/pattern.
+
+Declare the variables inside of the component/pattern’s class like below. Note
+that variables should be interdependent to enable quick restyling.
+
+```scss
+.card {
+  $card-background: tint($card-border-color, 10%);
+  $card-border-color: $base-border-color;
+  $card-border: 1px solid $card-border-color;
+  …
+}
+```
+
+## JavaScript
+
+If you change any JavaScript, please run `rake coffee` afterwards to
+generate the corresponding CoffeScript.
+
+**NOTE** - do not manually change any of the CoffeeScript files, they are
+automatically generated with `js2coffee`.
+
+## Build
+
+If you rename/remove/add any files to the repository, please make sure that the
+build reflects that change. Add your changed file to the `SNIPPETS` constant in
+the [test][spec_file] to have it tested.
+
+[spec_file]: https://github.com/thoughtbot/refills/blob/master/spec/refills/import_generator_spec.rb

data/Gemfile

@@ -1,13 +1,15 @@
-# If you have OpenSSL installed, we recommend updating
-# the following line to use "https"
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gem "middleman", "~>3.2.0"
-gem 'middleman-gh-pages'
-gem 'erubis'
+gem 'middleman'
 
-# Live-reloading plugin
-gem "middleman-livereload", "~> 3.1.0"
+gem 'bourbon', '~> 4.1.0'
+gem 'middleman-gh-pages'
+gem 'middleman-livereload', '~> 3.1.0'
+gem 'neat', '~> 1.7.0'
+gem 'sass', '~> 3.4.0'
 
-# For faster file watcher updates on Windows:
-gem "wdm", "~> 0.1.0", :platforms => [:mswin, :mingw]
+group :test do
+  gem 'rspec'
+  gem "generator_spec", github: "stevehodgkiss/generator_spec", tag: "0.9.3"
+  gem 'railties'
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2014–2015 [thoughtbot, inc.](http://thoughtbot.com)
+
+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

@@ -1,104 +1,91 @@
-# Refills
+[![Refills](http://images.thoughtbot.com/bourbon/refills-logo.svg)](http://refills.bourbon.io)
 
-## Prepackaged patterns and components, built on top of Bourbon, Bitters, and Neat
+[![Gem Version](http://img.shields.io/gem/v/refills.svg?style=flat)](https://rubygems.org/gems/refills)
+[![Build Status](https://travis-ci.org/thoughtbot/refills.svg?branch=master)](https://travis-ci.org/thoughtbot/refills)
 
+## Prepackaged patterns and components built with Bourbon and Neat
 
-[Bourbon](http://bourbon.io/) provides Sass mixins and eliminates vendor prefixes, for faster CSS coding.
+- **[Examples & Code Snippets](http://refills.bourbon.io)**
+- **[Changelog](https://github.com/thoughtbot/refills/releases)**
+- **[Issues & Bugs](https://github.com/thoughtbot/refills/issues)**
 
-[Neat](http://neat.bourbon.io/) provides a lightweight grid framework.
+## Requirements
 
-[Bitters](http://bitters.bourbon.io/) provides basic variables and structure to a Bourbon/Neat project.
+- [Sass](https://github.com/sass/sass) 3.3+
+- [Bourbon](https://github.com/thoughtbot/bourbon) 4.0+
+- [Neat](https://github.com/thoughtbot/neat) 1.6+
 
-[Refills](http://thoughtbot.github.io/refills/) provides "copy-paste" components and patterns based on Bourbon, Neat and Bitters.
+## Installation
 
+1. Install Refills’ dependencies: [Bourbon](https://github.com/thoughtbot/bourbon#installation), [Neat](https://github.com/thoughtbot/neat#installation) and [jQuery](http://jquery.com/download) (if you plan to use any components that require JavaScript).
 
-See examples and get the code snippets [here](http://thoughtbot.github.io/refills/)
+2. Go to the [Refills website](http://refills.bourbon.io), click “Show Code” under the component or pattern that you want and copy-paste it into your project.
 
-# Installing Dependencies
+3. Customize: Most of the components and patterns have a set of Sass variables that allow you to quickly tweak the look and feel.
 
-[Install Bourbon](http://bourbon.io/)
+## Installation for Ruby on Rails
 
-[Install Neat](http://neat.bourbon.io/)
+Alternative to copy-pasting manually, we also have a Refills gem that allows you to add components and patterns via Rake tasks.
 
-[Install Bitters](http://bitters.bourbon.io/)
+1. Add Refills to your Gemfile:
 
+  ```ruby
+  gem 'refills'
+  ```
 
-Make sure the following lines in "_bitters.scss" are uncommented:
-
-```scss
-@import "neat-helpers"; // or "neat/neat-helpers" when not in Rails
-@import "grid-settings";
-```
-
-
-[Install jQuery](http://www.w3schools.com/jquery/jquery_install.asp) (if you are using any of the components/patterns that require Javascript. Javascript, when used, can be found at the bottom of the HTML file.)
-
-Click "Show Code" under the component/pattern you want in [Refills](http://thoughtbot.github.io/refills/) and paste it into your project. 
-If a component/pattern has javascript it is placed in the HTML.erb file. Feel free to place it somewhere else in your project.
-
-# Using Refills
-
-* Click the "Show Code" link under the component/pattern you want to copy to your project and use the "copy" buttons to get the code to your clipboard. 
-* If a component uses Javascript, that code will be included at the bottom of the HTML file.
-* Each component/pattern has a set of variables at the very top of its Scss file. These pull out the most important properties of the component/pattern to enable quick changes of color, size and general appearance. 
+2. Then run:
 
+  ```bash
+  bundle install
+  ```
 
-#### Using Refills with a Rails project
-Refills can be used by simply copy-pasting components/patterns from the site but if you prefer adding them via rake tasks, follow these steps:
+3. Use the following Rails generators:
 
-Add gem to your Gemfile
+  List all available snippets:
 
-    gem 'refills'
+  ```bash
+  rails generate refills:list
+  ```
 
-The gem provides the following Rails generators
+  Add a snippet:
 
-* `rails generate refills:list`
-Lists all the available snippets
+  ```bash
+  rails generate refills:import SNIPPET
+  ```
 
-* `rails generate refills:import SNIPPET`
-Copies partials to `app/views/refills` and stylesheets to
-`app/assets/stylesheets/refills`
+  If you want to generate coffeescript instead of javascript, simply add `--coffee`
 
-# Submitting components or patterns
+  ```bash
+  rails generate refills:import SNIPPET --coffee
+  ```
 
-You are more than welcome to submit any component or pattern you can't find in the library, or feel free to send requests for content you'd like to see. When submitting a pull request, please think of these style guides:
+  This copies the snippet’s partial to `app/views/refills`, the stylesheet to `app/assets/stylesheets/refills` and the JavaScript to `app/assets/javascripts/refills`
 
-#### HTML.erb
+## Miscellaneous
 
-* Make sure that each component/pattern is independent of other components/patterns in the Refills library. There should be no dependencies between different components/patterns.
+If your css reset file does not add webkit antialias, add the following code to your Scss file:
 
-#### Scss
-
-All components/pattern should be fully responsive and follow the [Neat examples](http://neat.bourbon.io/examples/).
-
-Avoid more than 2 levels of nesting for clarity and legibility of code.
-
-Try to use as little styling as possible. Use the styles that come with Bitters to keep everything consistent.
-
-Put media queries inline, don't separate them since that will create a lot of repetitions of class names. If needed, for the sake of clarity, create a specific variable for a media query if a certain breakpoint changes the component/pattern drastically:
-
-      $tab-mode: $medium-screen;
-      
-      @include media($tab-mode) { // $tab-mode is the same as $medium-screen here
-        border-radius: 0;
-      }
+```css
+body {
+  -webkit-font-smoothing: antialiased;
+}
+```
 
-Create variables for any color or size that might appear in a refill, Especially if it appears more than once in the component/pattern.
+## The Bourbon family
 
-Declare the variables inside of the component/pattern's class like below. Note that variables should be interdependent to enable quick restyling.
+- [Bourbon](https://github.com/thoughtbot/bourbon): A simple and lightweight mixin library for Sass
+- [Neat](https://github.com/thoughtbot/neat): A lightweight semantic grid framework for Sass and Bourbon
+- [Bitters](https://github.com/thoughtbot/bitters): Scaffold styles, variables and structure for Bourbon projects
+- [Refills](https://github.com/thoughtbot/refills): Prepackaged patterns and components built with Bourbon, Neat and Bitters
 
-    .card {
-      $card-border-color: $base-border-color;
-      $card-border: 1px solid $card-border-color;
-      $card-background: lighten($card-border-color, 10);
-      ...
+## Credits
 
-# Credits
+[![thoughtbot](http://images.thoughtbot.com/bourbon/thoughtbot-logo.svg)](http://thoughtbot.com)
 
-![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+Refills is maintained and funded by [thoughtbot, inc](http://thoughtbot.com). Tweet your questions or suggestions to [@bourbonsass](https://twitter.com/bourbonsass) and while you’re at it follow us too.
 
-Refills is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community). Whenever a code snippet is borrowed or inspired by existing code, we try to credit the original developer/designer in our source code. Let us know if you think we have missed to do this.
+Whenever code for Refills is borrowed or inspired by existing code, we try to credit the original developer/designer in our source code. [Let us know](mailto:design+bourbon@thoughtbot.com) if you think any credit is absent.
 
-# License
+## License
 
-Refills is Copyright © 2014 thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.
+Copyright © 2014–2015 [thoughtbot, inc](http://thoughtbot.com). Refills is free software, and may be redistributed under the terms specified in the [license](LICENSE.md).