modular-scale 1.0.2 → 1.0.3

data/README.mdown

@@ -24,7 +24,7 @@ Modular-scale is used as a function. Simply pass it through in place of any valu
 width: modular-scale(2); // two up the modular scale
 width: ms(2); // Shorthand for the line above
 width: modular-scale(2, 1em); // two up the modular scale with a base size of 1em
-width: modular-scale(2, 1em, $octave); // Same as above but on an octave scale
+width: modular-scale(2, 1em, octave() ); // Same as above but on an octave scale
 ```
 
 You can output a list to your terminal to help you find out what values are on your scale.
@@ -50,7 +50,7 @@ Sassy Modular Scale can be used as a function, like so:
 
 ```scss
 // Use as a function. Fill in the multiple, base-size, and ratio
-height: modular-scale(7, 16px, $golden);
+height: modular-scale(7, 16px, golden() );
 ```
 
 
@@ -59,7 +59,7 @@ You can also 'lace' multiple ratios together by passing them in as a list (space
 
 ```scss
 .lace {
-  width: ms(7, 16px, $golden $fourth);
+  width: ms(7, 16px, golden() fourth() );
 }
 ```
 
@@ -68,7 +68,7 @@ You can also set the $base-size variable to a list to interrelate two significan
 
 ```scss
 .multibases {
-  width: ms(7, 16px 300px, $golden);
+  width: ms(7, 16px 300px, golden() );
 }
 ```
 
@@ -76,39 +76,45 @@ You can use multiple $base-sizes and multiple $ratios together
 
 ```scss
 .multibase-multiratio {
-  width: ms(7, 16px 300px, $golden $fourth);
+  width: ms(7, 16px 300px, golden() fourth() );
 }
 ```
 
-
 ## Ratios
 
-The included ratios are called by functions. You can add your own ratios as well.
-
-Below is a list of ratios to choose from. By default, the variable `$ratio` is set to `golden()`.
-
-* golden()
-* double-octave()
-* major-twelfth()
-* major-eleventh()
-* major-tenth()
-* octave()
-* major-seventh()
-* minor-seventh()
-* major-sixth()
-* minor-sixth()
-* fifth()
-* augfourth()
-* fourth()
-* major-third()
-* minor-third()
-* major-second()
-* minor-second()
+Modular scale includes functions for a number of classic design and musical scale ratios. You can add your own ratios as well.
+
+By default, the variable `$ratio` is set to `golden()`.
+
+<table>
+
+  <tr><th>Function</th><th>Ratio</th><th>Decimal value</th></tr>
+
+  <tr><td>golden()</td><td>1:1.618</td><td>1.618</td></tr>
+  <tr><td>double-octave()</td><td>1:4</td><td>4</td></tr>
+  <tr><td>major-twelfth()</td><td>1:3</td><td>3</td></tr>
+  <tr><td>major-eleventh()</td><td>3:8</td><td>2.667</td></tr>
+  <tr><td>major-tenth()</td><td>2.5</td><td>2:5</td></tr>
+  <tr><td>octave()</td><td>1:2</td><td>2</td></tr>
+  <tr><td>major-seventh()</td><td>8:15</td><td>1.875</td></tr>
+  <tr><td>minor-seventh()</td><td>9:16</td><td>1.778</td></tr>
+  <tr><td>major-sixth()</td><td>3:5</td><td>1.667</td></tr>
+  <tr><td>minor-sixth()</td><td>5:8</td><td>1.6</td></tr>
+  <tr><td>fifth()</td><td>2:3</td><td>1.5</td></tr>
+  <tr><td>augmented-forth()</td><td>1:√2</td><td>1.414</td></tr>
+  <tr><td>fourth()</td><td>3:4</td><td>1.333</td></tr>
+  <tr><td>major-third()</td><td>4:5</td><td>1.25</td></tr>
+  <tr><td>minor-third()</td><td>5:6</td><td>1.2</td></tr>
+  <tr><td>major-second()</td><td>8:9</td><td>1.125</td></tr>
+  <tr><td>minor-second()</td><td>15:16</td><td>1.067</td></tr>
+
+</table>
 
 Add your own ratio in Sass by setting a variable and passing that to modular-scale.
 
 ```scss
 $my-variable: 1 / 3.14159265;
+$ratio: $my-variable;
 ```
 
 ## Inspiration

data/lib/modular-scale.rb

@@ -7,7 +7,7 @@ Compass::Frameworks.register("modular-scale", :path => "#{File.dirname(__FILE__)
 # end
 
 module ModularScale
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
   DATE = "2012-08-13"
 end
 

data/stylesheets/_modular-scale.sass

@@ -4,10 +4,10 @@
 // Defaults
 $ratio: golden_ratio() !default
 $base-size: 16px !default
-$round_pixels: true !default
+$round-pixels: true !default
 
 // Modular Scale function
-@function modular-scale($multiple, $base-size: $base-size, $ratio: $ratio, $round_pixels: $round_pixels)
+@function modular-scale($multiple, $base-size: $base-size, $ratio: $ratio, $round-pixels: $round-pixels)
   // return the $base-size if $multiple is zero
   @if $multiple == 0
     @if type-of($base-size) == 'list'
@@ -20,32 +20,32 @@ $round_pixels: true !default
   // and multiple ratios are passed in as a list
   // calculate values in using each base-size / ratio combination
   @if type-of($base-size) == 'list' and type-of($ratio) == 'list'
-    @if unit(ms-multibase-multiratio($multiple, $base-size, $ratio)) == 'px' and $round_pixels == true
+    @if unit(ms-multibase-multiratio($multiple, $base-size, $ratio)) == 'px' and $round-pixels == true
       @return round(ms-multibase-multiratio($multiple, $base-size, $ratio))
     @return ms-multibase-multiratio($multiple, $base-size, $ratio)
 
   // if multiple base-sizes are passed in as a list
   // calculate values in using each base-size
   @if type-of($base-size) == 'list' and type-of($ratio) == 'number'
-    @if unit(ms-multibase($multiple, $base-size, $ratio)) == 'px' and $round_pixels == true
+    @if unit(ms-multibase($multiple, $base-size, $ratio)) == 'px' and $round-pixels == true
       @return round(ms-multibase($multiple, $base-size, $ratio))
     @return ms-multibase($multiple, $base-size, $ratio)
 
   // if multiple ratios are passed in as a list
   // calculate values in using each ratio
   @if type-of($base-size) == 'number' and type-of($ratio) == 'list'
-    @if unit(ms-multiratio($multiple, $base-size, $ratio)) == 'px' and $round_pixels == true
+    @if unit(ms-multiratio($multiple, $base-size, $ratio)) == 'px' and $round-pixels == true
       @return round(ms-multiratio($multiple, $base-size, $ratio))
     @return ms-multiratio($multiple, $base-size, $ratio)
 
   // If there are no lists just run the simple function
-  @if unit(power($ratio, $multiple) * $base-size) == 'px' and $round_pixels == true
+  @if unit(power($ratio, $multiple) * $base-size) == 'px' and $round-pixels == true
     @return round(power($ratio, $multiple) * $base-size)
   @return power($ratio, $multiple) * $base-size
 
 
 // calculate values in using each base-size / ratio combination
-@function ms-multibase-multiratio($multiple, $base-size, $ratio)
+@function ms-multibase-multiratio($multiple, $base-size: $base-size, $ratio: $ratio)
   // start with an empty list to place all values in
   $scale-values: ()
   // make sure base sizes are in ascending order
@@ -91,7 +91,7 @@ $round_pixels: true !default
 
 
 // calculate values in using each base-size
-@function ms-multibase($multiple, $base-size, $ratio)
+@function ms-multibase($multiple, $base-size: $base-size, $ratio: $ratio)
   // start with an empty list to place all values in
   $scale-values: ()
   // make sure base sizes are in ascending order
@@ -133,7 +133,7 @@ $round_pixels: true !default
 
 
 // calculate values in using each ratio
-@function ms-multiratio($multiple, $base-size, $ratio)
+@function ms-multiratio($multiple, $base-size: $base-size, $ratio: $ratio)
   // start with an empty list to place all values in
   $scale-values: ()
   // If $multiple is a positive integer (up the scale)
@@ -171,7 +171,7 @@ $round_pixels: true !default
 
 
 // trim and sort the final list
-@function trim-sort($multiple, $scale-values, $base-size)
+@function trim-sort($multiple, $scale-values: $scale-values, $base-size: $base-size)
   @if $multiple > 0
     // trim list so we can count from the lowest $base-size
     $scale-values: trim_list($scale-values, nth($base-size, 1), true)
@@ -195,26 +195,32 @@ $round_pixels: true !default
   @return golden_ratio()
 
 // Shortcut
-@function ms($args...)
+@function ms($multiple, $base-size: $base-size, $ratio: $ratio, $round-pixels: $round-pixels)
   // Return the value from the Modular Scale function
-  @return modular-scale($args...)
+  @return modular-scale($multiple, $base-size, $ratio, $round-pixels)
 
 // Write Modular Scale List
-@function modular-scale-list($start: 0, $finish: 20, $base-size: $base-size, $ratio: $ratio)
+@function modular-scale-list($start: 0, $finish: 20, $base-size: $base-size, $ratio: $ratio, $round-pixels: $round-pixels)
   $ms-list: unquote("MS-LIST:")
   @for $i from $start through $finish
-    $ms-list: append($ms-list, ms($i, $base-size, $ratio))
+    $ms-list: append($ms-list, ms($i, $base-size, $ratio, $round-pixels))
   @return $ms-list
 
-@function ms-list($start: 0, $finish: 20, $base-size: $base-size, $ratio: $ratio)
-  @return modular-scale-list($start, $finish, $base-size, $ratio)
+@function ms-list($start: 0, $finish: 20, $base-size: $base-size, $ratio: $ratio, $round-pixels: $round-pixels)
+  @return modular-scale-list($start, $finish, $base-size, $ratio, $round-pixels)
 
-=modular-scale-list($start: 0, $finish: 20, $base-size: $base-size, $ratio: $ratio)
-  @debug modular-scale-list($start, $finish, $base-size, $ratio)
+=modular-scale-list($start: 0, $finish: 20, $base-size: $base-size, $ratio: $ratio, $round-pixels: $round-pixels)
+  @debug modular-scale-list($start, $finish, $base-size, $ratio, $round-pixels)
 
-=ms-list($start: 0, $finish: 20, $base-size: $base-size, $ratio: $ratio)
-  @debug modular-scale-list($start, $finish, $base-size, $ratio)
+=ms-list($start: 0, $finish: 20, $base-size: $base-size, $ratio: $ratio, $round-pixels: $round-pixels)
+  @debug modular-scale-list($start, $finish, $base-size, $ratio, $round-pixels)
 
+=modular-scale-list-output($start: 0, $finish: 20, $base-size: $base-size, $ratio: $ratio, $round-pixels: $round-pixels)
+  MODULAR-SCALE-LIST
+    •: modular-scale-list($start, $finish, $base-size, $ratio, $round-pixels)
+
+=ms-list-output($start: 0, $finish: 20, $base-size: $base-size, $ratio: $ratio, $round-pixels: $round-pixels)
+  +modular-scale-list-output($start, $finish, $base-size, $ratio, $round-pixels)
 
 // Other libraries can easily query if this function is avalible
 $modular-scale-loaded: true

metadata

@@ -1,97 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: modular-scale
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Scott Kellum
 - Adam Stacoviak
 - Mason Wendell
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-13 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: compass
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 11
-        - 5
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.11.5
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sassy-math
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        version: "1.2"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.5
+- !ruby/object:Gem::Dependency
+  name: sassy-math
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :runtime
-  version_requirements: *id002
-description: Sassy Modular Scale calculates the incremental values of the modular scale.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Sassy Modular Scale calculates the incremental values of the modular
+  scale.
+email:
 - scott@scottkellum.com
 - adam@stacoviak.com
 - mason@canarypromo.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.mdown
 - lib/modular-scale.rb
 - stylesheets/_modular-scale.sass
-has_rdoc: true
 homepage: https://github.com/scottkellum/modular-scale
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Sassy Modular Scale calculates the incremental values of the modular scale in proportion to a set size and ratio. Inspired by and adapted from Tim Brown's modularscale.com.
+summary: Sassy Modular Scale calculates the incremental values of the modular scale
+  in proportion to a set size and ratio. Inspired by and adapted from Tim Brown's
+  modularscale.com.
 test_files: []
-