compass-pug 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWRhNDMyMmM4NzA4YTNkYjI2MDM4NWIzM2NmMGFhOTc0YmRhYTAwOA==
+    OThkM2ZhNjEzYjkzMTlmYjIyOTA2Y2ExZWRiYTg4NWMxZDAyNzM1MQ==
   data.tar.gz: !binary |-
-    MzhiNDc2NmZkZTAwNTkyMTg2NmUxYThlNDkwODc1ZjU1ODVjNDA4Mg==
+    NWE2ZmJjMTcyMWRhOTI3YzMyNzFjOGE2ZGYxZGJlNDc4ZTQzMTdkNw==
 SHA512:
   metadata.gz: !binary |-
-    MjRjZmFkZDA2MTFiZGRmNmI1NzUwNDgxYmE3NGNjYzQ1NzA5Yzg5M2Q5ZmE0
-    YWQzNDFlYjk0NjJkYjMxOTU2NzY5MGIzNWY0MDdjYzJmYTM0ZDA5YTZjZmQw
-    M2YyYzEyMzI4YjI0NDk5YTcwMGM1ZWJlMWY3OTViYTJiZmJlNWI=
+    MDNlNDE5NDViNDk1MGZjNzI5ZTNmMWI2ZjMxNTk1MDEzNjkzMzI0NDVhNzZm
+    Nzk5ZmY0MGY2NDI3ZjA2YjBhMDJlMzJiYzEzYjU0ZjgxNWExNDM0MDU3N2Iw
+    ZDJjZWI3NDAyMDQzNmIzNzM4ZTUxNDZmMzY2NzVjY2YyOWFiZGU=
   data.tar.gz: !binary |-
-    OWUzY2NlYjI3NDI3MGVjNDQ3MWJhYjQ5NTNjZDM2NDc5ODUzNzdkYzhhMzU1
-    MTkyZWJjZGJiYmU4MDQ3OTAzYWY2OTNlYmY4NjY2OWZlOTI1NThmNDk2ZWRi
-    OGE4ZTYyNzMwYmI3YTZlZmU1YjAwOTQzYzMxODAyODJiNmU4MWY=
+    ZTAzYjllZGVlNTBjMzZjZjEwOWJjZTI4ODM4YTE3OGYwNWE2ODY1NGNkNDAx
+    MzRiNDU2Y2YyMDcxODZkOGRmYzFkOGY2OWQwYTgxOTkyMWVjMmJhNWJmZjFj
+    YzYyYzhjY2E1NDUzYjEwZTMzZGVhMjE0MDQzNTczNWI4M2ZmN2M=

data/README.md

@@ -1,6 +1,6 @@
 # Pug for Compass
 
-A collection of Sass functions and mixins for use in Compass projects. It currently requires Sass `>=3.3` and Compass `>= 1.0.0.alpha.21`.
+A collection of Sass functions and mixins for use in Compass projects. It currently requires Compass `>= 1.0.0.rc.1`.
 
 ## Installation
 
@@ -8,7 +8,7 @@ Pug is distributed as a Ruby gem called `compass-pug`. You can install it with t
 
     gem install compass-pug
 
-Once the gem is installed, `require` it in your Compass project's config file:
+Once the gem is installed, `require` it in your Compass project's config file (probably called `config.rb`):
 
     require 'compass-pug'
 
@@ -18,17 +18,21 @@ And import the library itself in your Sass/SCSS code:
 
 ## What's Included
 
-For complete details, including function/mixin parameters, view the `stylesheets/pug/_functions.scss` and `stylesheets/pug/_mixins.scss` source files. And take a look at `stylesheets/_pug.scss` for various overridable configuration variables (define your own value for any of these prior to importing Pug).
+For complete details, including function/mixin parameters, view the `stylesheets/pug/_functions.scss` and `stylesheets/pug/_mixins.scss` source files. And take a look the Variables below (or at `stylesheets/_pug.scss`) for various overridable configuration variables (define your own value for any of these prior to importing Pug).
 
 ### Sass Mixins
 
+* `pug-aligncenter()`: Sets `display:block`, `clear:both` and auto l/r margin to horizontally center an element.
+* `pug-alignleft()`: Sets `display:inline`, `float:left` and applies some right margin based on the configured horizontal unit.
+* `pug-alignright()`: Sets `display:inline`, `float:right` and applies some left margin based on the configured horizontal unit.
+* `pug-clearfix()`: Clearfix. Alias for `pug-micro-clearfix()`.
 * `pug-dark-bg-with-light-text()`: Quickly apply bg, text and link colors to a selector appropriate for a dark background with light text.
 * `pug-light-bg-with-dark-text()`: Quickly apply bg, text and link colors to a selector appropriate for a light background with dark text.
 * `pug-micro-clearfix()`: [Provides Nicolas Gallagher's Micro Clearfix](http://nicolasgallagher.com/micro-clearfix-hack/).
 * `pug-placeholder-color()`: Generates cross-browser CSS (with selectors) for setting the color of input field placeholder text. Via [CSS Tricks](http://css-tricks.com/snippets/css/style-placeholder-text/).
 * `pug-tab-size()`: Vendor-prefixed tab sizing. Use with elements such as `pre`.
 * `pug-sr-only()`: Apply to an element to make it accessible only to screen readers. [Adapted from Bootstrap 3](http://getbootstrap.com/css/#helper-classes-screen-readers).
-* `pug-sr-only-focusable()`: Applies (optionally) `pug-sr-only` and shows the element again when it's focused. [Adapted from Bootstrap 3](http://getbootstrap.com/css/#helper-classes-screen-readers).
+* `pug-sr-only-focusable()`: Applies (optionally, and by default) `pug-sr-only()` and shows the element again when it's focused. [Adapted from Bootstrap 3](http://getbootstrap.com/css/#helper-classes-screen-readers).
 
 ### Sass Functions
 
@@ -36,3 +40,45 @@ For complete details, including function/mixin parameters, view the `stylesheets
 * `pug-round-up-to-nearest-vertical-unit()`: Round a size up to the nearest factor of a vertical unit (or of a sub-unit of that vertical unit). Parameters must use the same unit of measurement (rem, px, etc).
 * `pug-strip-units()`: Strip unit of measurement from a numeric value. Ex: `10px` becomes `10`.
 * `pug-units-match()`: Determine whether two or more values use the same unit of measurement (such as px, rem, etc). Similar to the Sass comparable() function but requires exact match (such as mm and mm, but not cm and mm).
+
+### Variables
+
+Below are the variables and their default values defined in `stylesheets/_pug.scss`. You can override any or all of these in your code by declaring them yourself *before* you import Pug (omit the `!default` flag shown on the definitions below if you do that).
+
+    $pug-bg-color-light: #FFF !default;
+    $pug-bg-color-dark: #202020 !default;
+
+    // Darkish text colors used on light backgrounds.
+    $pug-text-color-dark: #202020 !default;
+    $pug-link-default-color-dark: #4183c4 !default;
+    $pug-link-visited-color-dark: $pug-link-default-color-dark !default;
+    $pug-link-hover-color-dark: lighten($pug-link-default-color-dark, 20%) !default;
+
+    // Lightish text colors used on dark backgrounds.
+    $pug-text-color-light: #FEFEFE !default;
+    $pug-link-default-color-light: #9DC7F5 !default;
+    $pug-link-visited-color-light: $pug-link-default-color-light !default;
+    $pug-link-hover-color-light: lighten($pug-link-default-color-light, 20%) !default;
+
+    // Tab size
+    $pug-tab-size: 2 !default;
+
+    // Vars related to vertical-rhythm.
+    $pug-vr-base-font-size: 16px !default;
+    $pug-vr-vertical-unit: 24px !default;
+    $pug-vr-preferred-division: 0.5 !default;
+    $pug-vr-line-height-minimum-difference-proportion: 0.25 !default;
+
+    // Vars related to horizontal rhythm (gridding).
+    $pug-hr-horizontal-unit: 10px !default;
+
+
+## Development
+
+### Generating a Release
+
+* Update `README.md` with any new features or information required for usage
+* Replace the list of variable definitions in `README.md` with the ones in `stylesheets/_pug.scss` to make sure they are in sync
+* Update `s.version`, `s.date` and anything else that may need it in `compass-pug.gemspec`
+* Run `gem build compass-pug.gemspec` in the root of the repository (this will generate a new `compass-pug-[VERSION].gem` file)
+* Push that new file to `rubygems.org` with `gem push compass-pug-[VERSION].gem` (replace `[VERSION]` based on the actual name of the file)

data/stylesheets/_pug.scss

@@ -29,6 +29,9 @@ $pug-vr-vertical-unit: 24px !default;
 $pug-vr-preferred-division: 0.5 !default;
 $pug-vr-line-height-minimum-difference-proportion: 0.25 !default;
 
+// Vars related to horizontal rhythm (gridding).
+$pug-hr-horizontal-unit: 10px !default;
+
 // Imports
 // ---------------------------------------------------------------------------
 @import "pug/functions";

data/stylesheets/pug/_mixins.scss

@@ -1,5 +1,41 @@
 /* Pug - Core Mixins */
 
+/**
+ * Align center.
+ */
+@mixin pug-aligncenter {
+	clear: both;
+	display: block;
+	margin: 0 auto;
+}
+
+/**
+ * Align left.
+ */
+@mixin pug-alignleft {
+	display: inline;
+	float: left;
+	margin-right: $pug-hr-horizontal-unit;
+}
+
+/**
+ * Align right.
+ */
+@mixin pug-alignright {
+	display: inline;
+	float: right;
+	margin-left: $pug-hr-horizontal-unit;
+}
+
+/**
+ * Clearfix (alias for pug-micro-clearfix()).
+ *
+ * @see pug-micro-clearfix()
+ */
+@mixin pug-clearfix() {
+	@include pug-micro-clearfix();
+}
+
 /**
  * Quickly apply appropriate styles to an element for having a dark background.
  *

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: compass-pug
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrew Kamm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-27 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: sass
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: compass
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0.alpha.21
+        version: 1.0.0.rc.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0.alpha.21
+        version: 1.0.0.rc.1
 description: a collection of mixins for compass
 email: ak@kamm.co
 executables: []