compass-h5bp 0.1.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d909d3efd6b91890c366b4d89a50572b5b2a6ebc
+  data.tar.gz: 9981b7bde5aaf8b28917a793d643e9f42195052b
+SHA512:
+  metadata.gz: 2eddd19cd81518052fb8b05f37d7022202e5165be0e5fff97da08bdb0c5ff9e47a860d55eb23491f11061e6f7b6109dd3944e381b7a1f42b7ba950bee447af99
+  data.tar.gz: 8d5f523caf30805372aab9afc99069acc30a049711a2b865956891d3bd93eb6a0c8d46054cece94f309fe6d8b70c1acf8e5e58d2dbbea935e589ab2d0b82812f

data/.editorconfig

@@ -0,0 +1,16 @@
+# For more information about the properties used in
+# this file, please see the EditorConfig documentation:
+# http://editorconfig.org/
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{scss,html,rb}]
+indent_size = 2

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 .rvmrc
 test/project/css/*.css
 vendor/bundle
+*.sublime-*

data/LICENSE

@@ -1,3 +1,5 @@
+The MIT License (MIT)
+
 Copyright (c) 2011 Peter Gumeson
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -1,91 +1,87 @@
-Compass H5bp
-============
+# An HTML5 Boilerplate Extension for Compass
 
-This is a Compass extension of HTML5 mixins extracted from v4 of [HTML5 Boilerplate](http://html5boilerplate.com).
-This gem provides only the CSS mixins and not the HTML or Javascript templates. This makes sense because any 
-implementation of HTML5 Boilerplate should be specific to the language and framework it's built on.
+This is a [Compass extension](http://compass-style.org/help/tutorials/extensions/) of HTML5 mixins extracted from v5 of the [HTML5 Boilerplate](http://html5boilerplate.com).
 
-Browse [html5boilerplate.com](http://html5boilerplate.com) for the full workup.
+This gem provides only the CSS mixins and not the HTML or JavaScript templates. Implementation of these and similar files ought to be managed by the framework and language your project is built upon.
 
-Or, you can read more about compass extensions [here](http://compass-style.org/help/tutorials/extensions/).
+## Installation
 
+### Two options:
+* Install using gem:
+`gem install compass-h5bp`
 
-Installation
-============
+* Or, if you're using [Bundler](http://gembundler.com/), you can install it via `bundle install` by placing the following line in your Gemfile: `gem 'compass-h5bp'`
 
-Two options: 
+## Usage
 
----
-
-1) A raw install using gem:
+First, you must add the plugin to your `config.rb` (your Compass configuration file). This can be done be placing an
+import line at the top of the file and is required to add the Compass plugin to the Sass load paths:
 
-    gem install compass-h5bp
+    require 'compass-h5bp'
 
----
+Inside your SCSS (or Sass) file, you must import the `h5bp` compass library before you can use any of the mixins:
 
-2) Or, if using [Bundler](http://gembundler.com/). Place the following line in your Gemfile:
+    @import "h5bp";
 
-    gem 'compass-h5bp'
+### Simple Implementation
+1. Include the h5bp mixin:
 
-Then run:
+        @include h5bp;
 
-    $ bundle install
+2. *Optional:* Redefine the mixin `h5bp-custom` to declare custom modifications to the HTML5 Boilerplate styles.
 
+### Advanced Implementation
+To selectively import only certain elements, observe the following order. This ensures your custom modifications to the HTML Boilerplate styles will work as expected, by following the outline provided in the upstream HTML5 Boilerplate CSS.
 
-Usage
-=====
+1. Include the mixins that make up the [Normalize](http://necolas.github.com/normalize.css) portion of the HTML5
+Boilerplate styles. You can include all of Normalize at once:
 
-First, you must add the plugin to your `config.rb` (your Compass configuration file). This can be done be placing an
-import line at the top of the file and is required to add the compass plugin to the sass load paths:
+        @include h5bp-normalize;
 
-    require 'compass-h5bp'
-    
-Then, inside your SCSS (or Sass) file, you must import the `h5bp` compass library before you can use any of the mixins:
+ Or pull in only the portions of Normalize you want:
 
-    @import "h5bp";
+        @include normalize-base;
+        @include normalize-display;
+        @include normalize-links;
+        @include normalize-semantics;
+        @include normalize-embedded;
+        @include normalize-grouping;
+        @include normalize-forms;
+        @include normalize-tables;
 
-Then include the mixins that make up the [Normalize portion](http://necolas.github.com/normalize.css) of HTML5
-Boilerplate's styles. 
+2. Include the opinionated default base styles:
 
-You can include all of Normalize at once:
+        @include h5bp-base-styles;
 
-    @include h5bp-normalize;
+3. You can include the styling for the browser upgrade warning:
 
- Or pull in only the portions of Normalize you want:
+        @include h5bp-browserupgrade;
 
-    @include h5bp-display;
-    @include h5bp-base;
-    @include h5bp-links;
-    @include h5bp-typography;
-    @include h5bp-lists;
-    @include h5bp-embeds;
-    @include h5bp-figures;
-    @include h5bp-forms;
-    @include h5bp-tables;
+4. Provide styling to the 404 page (requires that you specify the class `errorpage` for the html of the 404 document):
 
-Next you can include the opinionated default base styles:
+        @include h5bp-errorpage;
 
-    @include h5bp-base-styles;
+5. Define your custom modifications to the HTML5 Boilerplate styles here.
 
-You can include the default Html5 Boilerplate Chrome Frame notification styling:
+6. Let h5bp define some semantic helper classes. (e.g. `.clearfix`):
 
-    @include h5bp-chromeframe;
+        @include h5bp-helpers;
 
-Now you can define your own custom CSS here.
+    There are also specific mixins provided in `h5bp-helpers` you can call instead.
 
-Then (optionally) let H5bp define some semantic helper classes. (e.g. `.clearfix`):
+7. Include h5bp's predefined print style media query:
 
-    @include h5bp-helpers;
+        @include h5bp-media;
 
-Finally, you can include H5bp's predefined print style media query:
+## Caveats
 
-    @include h5bp-media;
+If you're coming from [compass-h5bp](https://github.com/sporkd/compass-h5bp), be aware that several mixins have had their name changed, and any mixin or feature that had been marked for deprecation has been removed. That being said, migration should be relatively simple.
 
+The order for the "Advanced Implementation" matters. It's important to note that "custom modifications to the HTML5 Boilerplate styles" means only that - the rest of your SCSS goes below everything listed.
 
-License
-=======
+## Acknowledgments
 
 [HTML5 Boilerplate](http://html5boilerplate.com), created by by Paul Irish and Divya Manian.
 
 Copyright (c) 2012 Peter Gumeson.
-See [LICENSE](https://github.com/sporkd/compass-h5bp/blob/master/LICENSE) for full license.
+You can read a [summary of the MIT license](https://tldrlegal.com/license/mit-license#summary), or see [LICENSE](https://github.com/tohuw/compass-h5bp/blob/master/LICENSE) for the full license.

data/compass-h5bp.gemspec

@@ -1,23 +1,23 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "compass/h5bp/version"
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'compass/h5bp/version'
 
 Gem::Specification.new do |s|
-  s.name        = "compass-h5bp"
-  s.version     = Compass::H5bp::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Peter Gumeson"]
-  s.email       = ["gumeson@gmail.com"]
-  s.homepage    = "http://rubygems.org/gems/compass-h5bp"
-  s.summary     = %q{ Compass extension for Html5 Boilerplate v4.1 }
-  s.description = %q{ Compass extension of Html5 mixins extracted from v4 of the Html5 Boilerplate project (h5bp.com) }
-
-  s.rubyforge_project = "compass-h5bp"
+  s.name                  = 'compass-h5bp'
+  s.version               = Compass::H5bp::VERSION
+  s.platform              = Gem::Platform::RUBY
+  s.required_ruby_version = '~> 2.0'
+  s.authors               = ['Peter Gumeson']
+  s.email                 = 'gumeson@gmail.com'
+  s.homepage              = 'http://rubygems.org/gems/compass-h5bp'
+  s.summary               = 'Compass extension for HTML5 Boilerplate v5.0'
+  s.description           = 'Compass extension of HTML5 mixins extracted from the HTML5 Boilerplate project (h5bp.com)'
+  s.license               = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 
-  s.add_dependency("compass")
+  s.add_runtime_dependency 'compass', '~> 1.0', '>= 1.0.3'
 end

data/config.rb

@@ -0,0 +1,17 @@
+require 'compass/import-once/activate'
+# Require any additional compass plugins here.
+require 'compass-h5bp'
+
+css_dir = 'test/project/css'
+sass_dir = 'test/project/sass'
+
+# You can select your preferred output style here
+# (can be overridden via the command line):
+# output_style = :expanded or :nested or :compact or :compressed
+
+# To enable relative paths to assets via compass helper functions. Uncomment:
+# relative_assets = true
+
+# To disable debugging comments that display the
+# original location of your selectors. Uncomment:
+line_comments = false

data/lib/compass-h5bp.rb

@@ -1 +1 @@
-require "compass/h5bp"
+require 'compass/h5bp'

data/lib/compass/h5bp.rb

@@ -1,7 +1,11 @@
-require "compass/h5bp/version"
+require 'compass/h5bp/version'
 
 module Compass
-  module H5bp
-    Compass::Frameworks.register("compass-h5bp", :path => "#{File.dirname(__FILE__)}/../..")
+  # HTML5 Boilerplate v5 Compass Extension
+  module Html5bp
+    Compass::Frameworks.register(
+      'compass-h5bp',
+      path: "#{File.dirname(__FILE__)}/../.."
+    )
   end
 end

data/lib/compass/h5bp/version.rb

@@ -1,6 +1,6 @@
 module Compass
   module H5bp
-    VERSION = "0.1.2"
-    HTML5_BOILERPLATE_VERSION = "4.1.0"
+    VERSION = "1.0.0"
+    HTML5_BOILERPLATE_VERSION = "5.0"
   end
 end

data/stylesheets/_h5bp.scss

@@ -2,9 +2,26 @@
 //
 // What follows is the result of much research on cross-browser styling.
 // Credit left inline and big thanks to Nicolas Gallagher, Jonathan Neal,
-// Kroc Camen, and the H5BP dev community and team.
+// Kroc Camen, and the h5bp dev community and team.
 
-@import "h5bp/normalize";
-@import "h5bp/main";
-@import "h5bp/helpers";
-@import "h5bp/media";
+@import 'h5bp/normalize';
+@import 'h5bp/main';
+@import 'h5bp/browserupgrade';
+@import 'h5bp/errorpage';
+@import 'h5bp/helpers';
+@import 'h5bp/media';
+
+@mixin h5bp-custom {
+    // Redefine this mixin to add custom modifications to H5BP styles.
+
+}
+
+@mixin h5bp {
+    @include h5bp-normalize;
+    @include h5bp-main;
+    @include h5bp-browserupgrade;
+    @include h5bp-errorpage;
+    @include h5bp-custom;
+    @include h5bp-helpers;
+    @include h5bp-media;
+}

data/stylesheets/h5bp/_browserupgrade.scss

@@ -0,0 +1,9 @@
+// Browser Upgrade Message
+@mixin h5bp-browserupgrade {
+  .browserupgrade {
+      margin: 0.2em 0;
+      background: #ccc;
+      color: #000;
+      padding: 0.2em 0;
+  }
+}

data/stylesheets/h5bp/_errorpage.scss

@@ -0,0 +1,45 @@
+@mixin h5bp-errorpage {
+    html.errorpages {
+        color: #888;
+        display: table;
+        font-family: sans-serif;
+        height: 100%;
+        text-align: center;
+        width: 100%;
+
+        * {
+            line-height: 1.2;
+            margin: 0;
+        }
+
+        body {
+            display: table-cell;
+            vertical-align: middle;
+            margin: 2em auto;
+        }
+
+        h1 {
+            color: #555;
+            font-size: 2em;
+            font-weight: 400;
+        }
+
+        p {
+            margin: 0 auto;
+            width: 280px;
+        }
+
+        @media only screen and (max-width: 280px) {
+
+            body, p {
+                width: 95%;
+            }
+
+            h1 {
+                font-size: 1.5em;
+                margin: 0 0 0.3em;
+            }
+
+        }
+    }
+}

data/stylesheets/h5bp/_helpers.scss

@@ -1,57 +1,26 @@
-//
 // Helper classes
-//
-
 @mixin h5bp-helpers {
 
-  .ir { @include image-replacement; }
+  .hidden { @include h5bp-hidden; }
 
-  .hidden { @include hidden; }
+  .visuallyhidden { @include h5bp-visuallyhidden; }
 
-  .visuallyhidden { @include visually-hidden; }
-  
-  .invisible { @include invisible; }
+  .invisible { @include h5bp-invisible; }
 
-  .clearfix { @include micro-clearfix; }
+  .clearfix { @include h5bp-clearfix; }
 
 }
 
-// Image replacement
-@mixin image-replacement($img: none, $x: 50%, $y: 50%) {
-  background-color: transparent;
-  border: 0;
-  overflow: hidden;
-  // IE 6/7 fallback
-  *text-indent: -9999px;
-
-  &:before {
-    content: "";
-    display: block;
-    width: 0;
-    height: 150%;
-  }
-
-  @if $img != none {
-    background-image: image-url($img);
-    background-position: $x $y;
-  }
-}
-
-// Uses image dimensions
-@mixin sized-image-replacement($img, $x: 50%, $y: 50%) {
-  @include image-replacement($img, $x, $y);
-  width: image-width($img);
-  height: image-height($img);
-}
-
-// Hide from both screenreaders and browsers: h5bp.com/u
-@mixin hidden {
+// Hide from both screenreaders and browsers:
+// http://juicystudio.com/article/screen-readers-display-none.php
+@mixin h5bp-hidden {
   display: none !important;
   visibility: hidden;
 }
 
-// Hide only visually, but have it available for screenreaders: h5bp.com/v
-@mixin visually-hidden {
+// Hide only visually, but have it available for screenreaders:
+// http://snook.ca/archives/html_and_css/hiding-content-for-accessibility
+@mixin h5bp-visuallyhidden {
   border: 0;
   clip: rect(0 0 0 0);
   height: 1px;
@@ -60,9 +29,9 @@
   padding: 0;
   position: absolute;
   width: 1px;
-  
+
   // Extends the .visuallyhidden class to allow the element to be focusable
-  // when navigated to via the keyboard: h5bp.com/p
+  // when navigated to via the keyboard: https://www.drupal.org/node/897638
   &.focusable:active,
   &.focusable:focus {
     clip: auto;
@@ -75,7 +44,7 @@
 }
 
 // Hide visually and from screenreaders, but maintain layout
-@mixin invisible {
+@mixin h5bp-invisible {
   visibility: hidden;
 }
 
@@ -88,7 +57,7 @@
 //    that receive the `clearfix` class.
 // 2. The use of `table` rather than `block` is only necessary if using
 //    `:before` to contain the top-margins of child elements.
-@mixin micro-clearfix {
+@mixin h5bp-clearfix {
   &:before,
   &:after {
     content: " "; // 1
@@ -98,10 +67,4 @@
   &:after {
     clear: both;
   }
-
-  // For IE 6/7 only
-  // Include this rule to trigger hasLayout and contain floats.
-  & {
-    *zoom: 1;
-  }
-}
+}