bourbon 0.0.6 → 0.0.7

data/.gitignore

@@ -1,3 +1,4 @@
 *swp
 *gem
 .sass-cache/
+sass/

data/app/assets/stylesheets/_bourbon.css.scss

@@ -1,5 +1,6 @@
 // Custom Functions
 @import "functions/compact";
+@import "functions/golden-ratio";
 @import "functions/tint-shade";
 
 // CSS3 Mixins

data/app/assets/stylesheets/functions/_golden-ratio.css.scss

@@ -0,0 +1,32 @@
+@function golden-ratio($value, $increment) {
+  @if $increment > 0 {
+    @for $i from 1 through $increment {
+      $value: ($value * 1.618);
+    }
+  }
+  @if $increment < 0 {
+    $increment: abs($increment);
+    @for $i from 1 through $increment {
+      $value: ($value / 1.618);
+    }
+  }
+  @if $increment == 0 {
+    @warn "Increment value cannot be zero; must be ...-3, -2, -1, 1, 2, 3...";
+  }
+  @return $value;
+}
+
+//  div {
+//                  Increment Up GR with positive value
+//    width:        golden-ratio(14px,  1);    // returns: 22.652px
+//
+//                  Increment Down GR with negative value
+//    width:        golden-ratio(14px, -1);    // returns: 8.653px
+//
+//                  Can be used with ceil(round up) or floor(round down)
+//    width: floor( golden-ratio(14px,  1) );  // returns: 22px
+//    width:  ceil( golden-ratio(14px,  1) );  // returns: 23px
+//  }
+//
+// modularscale.com
+// goldenratiocalculator.com

data/generate-sass.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+# README
+# This will generate a sass directory and convert all .css.scss to .scss extensions.
+# The sass directory is for 'sass --watch' use outside of rails.
+# Step 1: Make install executable by changing permission
+#     chmod a+x generate-sass.sh
+
+# Step 2: Generate Files
+#     ./generate-sass.sh
+
+echo Creating directory...
+mkdir -p $PWD/sass
+
+echo Copying files...
+cp -a $PWD/app/assets/stylesheets/* $PWD/sass
+
+echo Renaming files...
+find $PWD/sass -name "*.css.scss" | while read i;
+  do mv "$i" "${i%.css.scss}.scss";
+done
+echo Done.
+

data/lib/bourbon/version.rb

@@ -1,3 +1,3 @@
 module Bourbon
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/readme.md

@@ -2,50 +2,68 @@
 The purpose of Bourbon Vanilla Sass Mixins is to provide a comprehensive framework of sass mixins that are designed to be as vanilla as possible. Meaning they should not deter from the original CSS syntax. The mixins contain vendor specific prefixes for all CSS3 properties for support amongst modern browsers. The prefixes also ensure graceful degradation for older browsers that support only CSS3 prefixed properties.
 
 
-##Requirements
+#Requirements
 Sass 3.1+
 
 
-##Install
-**Update your Gemfile**
+#Install for Rails
+Update your Gemfile
 
     gem 'bourbon'
 
     bundle install
 
-###Rails 3.1.x
-**Comment-out the following sprocket directive in /application.css.scss** (Remove the =)
+##Rails 3.1.x
+Comment-out the following sprocket directive in /application.css.scss (Remove the =)
 
     * require_tree .
 
-**Import the mixins at the beginning of your stylesheet**
+Import the mixins at the beginning of your stylesheet
 
     @import 'bourbon';
 
-###Rails 3.0.9 and below
-**For Rails < 3.1 you must run the installation rake task.**
+##Rails 3.0.9 and below
+For Rails < 3.1 you must run the installation rake task.
 This will copy the Sass files into your project's public/stylesheets/sass directory.
 
     rake bourbon:install
 
-**Import the mixins at the beginning of your stylesheet**
+Import the mixins at the beginning of your stylesheet
 
     @import 'bourbon/bourbon';
 
 
-##Usage
+#Install without Rails
+The following script will generate a sass directory and convert all .css.scss to .scss extensions. The sass directory is for 'sass --watch' use outside of rails.  
+Preliminary step: clone the repo and cd into the directory.
+
+**Step 1:** Make script executable by changing file permission
+
+    chmod a+x generate-sass.sh
+
+**Step 2:** Generate files
+
+    ./generate-sass.sh
+
+**Step 3:** Move the new *sass* directory to your project's stylesheets directory.
+
+
+#Using Bourbon Vanilla Mixins
 Below are a few examples of mixin usage. Note that these are just a few, explore the repo to find out more.
 
-**Animation**
+###Animation
 
-The three following properties support a comma separated list of values, which allows different transitions for individual properties to be described in a single style rule. Each value in the list corresponds to the value at that same position in the other properties. animation-name | animation-duration | animation-timing-function
+The animation mixins support comma separated lists of values, which allows different transitions for individual properties to be described in a single style rule. Each value in the list corresponds to the value at that same position in the other properties.
 
     @include animation-name(slideup, fadein);
     @include animation-duration(1.0s, 1.2s);
     @include animation-timing-function(ease-in-out, ease-out);
 
+    # Shorthand for a basic animation. Supports multiple parentheses-deliminated values for each variable.
+    @include animation-basic((slideup, fadein), (1.0s, 2.0s), ease-in);
+
 
-**Border Radius**
+###Border Radius
 
 Border-radius will also take short-hand notation.
 
@@ -53,38 +71,24 @@ Border-radius will also take short-hand notation.
     @include border-radius(5px 5px 2px 2px);
 
 
-Shorthand for a basic animation. Supports multiple parentheses-deliminated values for each variable.
-
-    @include animation-basic((slideup, fadein), (1.0s, 2.0s), ease-in);
-
-
-**Box Shadow**
+###Box Shadow
 
 Box-Shadow supports single or multiple arguments:
 
     @include box-shadow(1px 1px 2px 0 #ff0000);
 
-Multiple arguments must be comma-diliminated.
-
+    # Multiple arguments must be comma-diliminated.
     @include box-shadow(1px 1px 2px 0 #fff0000, -1px -2px 0 #ccc);
 
 
-**Border Radius**
-
-Border-radius will also take short-hand notation.
+###Box Sizing
 
-    @include border-radius(10px);
-    @include border-radius(5px 5px 2px 2px);
-
-
-**Box Sizing**
-
-Box-sizing will change the box-model of the element it is applied to. This is really helpful for properly styling padding and margin to all text-based input types (e.g. input[type="text"]).
+Box-sizing will change the box-model of the element it is applied to.
 
     @include box-sizing(border-box);
 
 
-**Flex Box**
+###Flex Box
 
 The flex-box mixin is based on the 2009 w3c spec. The mixin with change to the flexible box-model. [More info.](http://www.w3.org/TR/2009/WD-css3-flexbox-20090723/)
 
@@ -99,14 +103,15 @@ The flex-box mixin is based on the 2009 w3c spec. The mixin with change to the f
       @include box-flex(2);
     }
 
-**Inline-block**
+
+###Inline-block
 
 The inline-block mixin provides support for the inline-block property in IE6 and IE7.
 
     @include inline-block;
 
 
-**Linear-Gradient**
+###Linear-Gradient
 
 Gradient position is optional, default is top. Position can be a degree. Color-stops are optional as well. Mixin will support up to 10 gradients.
 
@@ -115,7 +120,7 @@ Gradient position is optional, default is top. Position can be a degree. Color-s
     @include linear-gradient(50deg, #1e5799 0%, #2989d8 50%, #207cca 51%, #7db9e8 100%);
 
 
-**Position**
+###Position
 
 Shorthand notation for setting the position of elements in your page.
 
@@ -134,19 +139,20 @@ The first parameter is optional, with a default value of relative. The second pa
 Note: unitless values will be ignored. In the example above, this means that selectors will not be generated for the right and bottom positions, while the top position is set to 0px.
 
 
-**Radial-Gradient**
+###Radial-Gradient
 
 Takes up to 10 gradients. Position and shape are required.
 
     @include radial-gradient(50% 50%, circle cover, #1e5799, #efefef);
     @include radial-gradient(50% 50%, circle cover, #eee 10%, #1e5799 30%, #efefef);
 
-**Transform**
+
+###Transform
 
     @include transform(translateY(50px));
 
 
-**Transitions**
+###Transitions
 
 Shorthand mixin: Supports multiple parentheses-deliminated values for each variable.
 
@@ -155,12 +161,54 @@ Shorthand mixin: Supports multiple parentheses-deliminated values for each varia
     @include transition ($property:(opacity, width), $delay: (1.5s, 2.5s));`
 
 
-##Add-ons
+##Functions
+###Compact
+
+The compact function will strip out any value from a list that is 'false'. Takes up to 10 arguments.
+
+    $full:  compact($name-1, $name-2, $name-3, $name-4, $name-5, $name-6, $name-7, $name-8, $name-9, $name-10);
+
+
+###Golden Ratio
+
+Returns the golden ratio of a given number. Must provide a Pixel or Em value for first argument. Also takes a required increment value that is not zero and an integer: ...-3, -2, -1, 1, 2, 3...
+
+    div {
+                    Increment Up GR with positive value
+      width:        golden-ratio(14px,  1);    // returns: 22.652px
+
+                    Increment Down GR with negative value
+      width:        golden-ratio(14px, -1);    // returns: 8.653px
+
+                    Can be used with ceil(round up) or floor(round down)
+      width: floor( golden-ratio(14px,  1) );  // returns: 22px
+      width:  ceil( golden-ratio(14px,  1) );  // returns: 23px
+    }
+
+Resources: [modularscale.com](http://modularscale.com) & [goldenratiocalculator.com](http://goldenratiocalculator.com)
+
 
-**Buttons**
+###Tint & Shade
 
-The button add-on provides well-designed buttons with a single line in your CSS. The demo folder contains examples of the buttons in use.
+Tint & shade are different from lighten() and darken() functions built into sass.  
+Tint is a mix of a color with white. Tint takes a color and a percent argument.
 
+    div {
+      background: tint(red, 40%);
+    }
+
+Shade is a mix of a color with black. Shade takes a color and a percent argument.
+
+    div {
+      background: shade(blue, 60%);
+    }
+
+
+##Add-ons
+
+###Buttons
+
+The button add-on provides well-designed buttons with a single line in your CSS. The demo folder contains examples of the buttons in use.  
 The mixin can be called with no parameters to render a blue button with the "simple" style.
 
     button,
@@ -183,6 +231,62 @@ The real power of the mixin is revealed when you pass in the optional color argu
     }
 
 
+#All Supported Functions, Mixins, and Addons
+*@ denotes a mixin and must be prefaced with @include*
+
+    #Functions
+    --------------------------------
+      compact(*args)
+      golden-ratio(*args)
+      shade(*args)
+      tint(*args)
+
+    #Mixins
+    --------------------------------
+      animation
+        @ animation(*args)
+        @ animation-basic(*args)
+        @ animation-delay(*args)
+        @ animation-direction(*args)
+        @ animation-duration(*args)
+        @ animation-fill-mode(*args)
+        @ animation-iteration-count(*args)
+        @ animation-name(*args)
+        @ animation-play-state(*args)
+        @ animation-timing-function(*args)
+
+      @ border-radius(*args)
+      @ box-sizing(*args)
+
+      flex-box
+        @ box-align(*args)
+        @ box-direction(*args)
+        @ box-flex(*args)
+        @ box-flex-group(*args)
+        @ box-lines(*args)
+        @ box-ordinal-group(*args)
+        @ box-orient(*args)
+        @ box-pack(*args)
+        @ display-box
+
+      @ inline-block
+      @ linear-gradient(*args)
+      @ radial-gradient(*args)
+      @ transform(*args)
+
+      transition
+        @ transition(*args)
+        @ transition-delay(*args)
+        @ transition-duration(*args)
+        @ transition-property(*args)
+        @ transition-timing-function(*args)
+
+    #Addons
+    --------------------------------
+    @ button(*args)
+    @ position(*args)
+
+
 ##Help Out
 Currently the project is a work in progress. Feel free to help out.
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bourbon
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Phil LaPier
@@ -68,11 +68,13 @@ files:
 - app/assets/stylesheets/css3/_transform.css.scss
 - app/assets/stylesheets/css3/_transition.css.scss
 - app/assets/stylesheets/functions/_compact.css.scss
+- app/assets/stylesheets/functions/_golden-ratio.css.scss
 - app/assets/stylesheets/functions/_tint-shade.css.scss
 - bourbon.gemspec
 - demo/index.html
 - demo/stylesheets/demo.css
 - demo/stylesheets/scss/demo.scss
+- generate-sass.sh
 - lib/bourbon.rb
 - lib/bourbon/engine.rb
 - lib/bourbon/version.rb