modular-scale 0.0.1

data/README.mdown

@@ -0,0 +1,84 @@
+# Sassy Modular Scale
+#### Put down the calculator and let Sass do the work.
+
+# Usage and Installation
+
+Sassy Modular Scale is written in Sass and requires Sass to be used. Visit [sass-lang.com](http://sass-lang.com) to learn more and install.
+
+* Copy either `stylesheets/_modular-scale.sass` or `stylesheets/_modular-scale.scss` into your project
+* Import the file into your Sass stylesheet to access the mixins and functions
+
+Sassy Modular Scale can be used as a function, mixin or a mixin that generates a range of classes to `@extend`.
+
+Examples using the Sass syntax:
+
+    // Use as a function. Fill in the multiple, base-size, and ratio
+    height: modular-scale(7, 14px, $golden)
+    
+    // Use as a mixin. Fill in the property, multiple, base-size, and ratio
+    +modular-scale(line-height, 1, 14px, $golden)
+    
+    // This method will generate a range of classes to `@extend`
+    +modular-scale-classes(6)
+
+    [role="main"]
+      h1
+        @extend .ms-2
+      h2
+        @extend .ms-1
+      h3
+        @extend .ms-0
+
+Examples using the SCSS syntax:
+
+    // Use as a function. Fill in the multiple, base-size, and ratio
+    height: modular-scale(7, 14px, $golden);
+    
+    // Use as a mixin. Fill in the property, multiple, base-size, and ratio
+    @include modular-scale(line-height, 1, 14px, $golden);
+
+    // This method will generate a range of classes to `@extend`
+    @ionclude modular-scale-classes(6);
+
+    [role="main"] {
+      h1 { @extend .ms-2; }
+      h2 { @extend .ms-1; }
+      h3 { @extend .ms-0; }
+    }
+
+# Ratios
+
+Below is a list of Ratios to choose from. By default, the variable `$ratio` is set to `$golden`.
+
+* $golden: 1.618
+* $octave: 2 / 1
+* $major-seventh: 15 / 8
+* $minor-seventh: 16 / 9
+* $major-sixth: 5 / 3
+* $minor-sixth: 8 / 5
+* $fifth: 3 / 2
+* $fourth: 4 / 3
+* $major-third: 5 / 4
+* $minor-third: 6 / 5
+* $major-second: 9 / 8
+* $minor-second: 16 / 15
+
+# Credits
+
+#### Sass mixin by Scott Kellum
+
+* [https://github.com/scottkellum/modular-scale](https://github.com/scottkellum/modular-scale)
+* [@scottkellum](http://twitter.com/scottkellum)
+
+#### Adapted from modularscale.com by Tim Brown
+
+* [http://modularscale.com/](http://modularscale.com/)
+* [@nicewebtype](http://twitter.com/nicewebtype)
+
+#### Related link:
+
+* [http://alistapart.com/articles/more-meaningful-typography/](http://alistapart.com/articles/more-meaningful-typography/)
+
+#### Additional credit to Robert Bringhurst
+
+* The Elements of Typographic Style (Chapter 8: Shaping the page)

data/lib/modular-scale.rb

@@ -0,0 +1,9 @@
+require 'compass'
+Compass::Frameworks.register("modular-scale", :path => "#{File.dirname(__FILE__)}/..")
+
+module ModularScale
+  
+  VERSION = "0.0.1"
+  DATE = "2011-08-14"
+
+end

data/stylesheets/_modular-scale.sass

@@ -0,0 +1,56 @@
+// Ratios
+$golden: 1.618 
+$octave: (2 / 1)
+$major-seventh: (15 / 8)
+$minor-seventh: (16 / 9)
+$major-sixth: (5 / 3)
+$minor-sixth: (8 / 5)
+$fifth: (3 / 2)
+$fourth: (4 / 3)
+$major-third: (5 / 4)
+$minor-third: (6 / 5)
+$major-second: (9 / 8)
+$minor-second: (16 / 15)
+
+// Defaults
+$ratio: $golden !default
+$base-size: 12px !default
+$property: font-size !default
+$class-slug: ms !default
+
+// Modular Scale function
+@function modular-scale($multiple, $base-size, $ratio)
+
+  // On init, $modular-scale equals the default value of $base-size or the value passed to the function
+  $modular-scale: $base-size
+
+  // If $multiple is a positive integer (up the scale)
+  @if $multiple > 0
+    @for $i from 1 through $multiple
+      $modular-scale: $modular-scale * $ratio
+
+  // If $multiple is a negative integer (down the scale)
+  @if $multiple < 0
+    @for $i from 1 through ($multiple * -1)
+      $modular-scale: $modular-scale / $ratio
+
+  // Return the new or unchanged value of $modular-scale
+  @return $modular-scale
+  
+// Shortcut
+@function ms($multiple, $base-size, $ratio)
+  // Return the value from the Modular Scale function
+  @return modular-scale($multiple, $base-size, $ratio)
+
+// Mixin
+=modular-scale($property, $multiple, $base-size, $ratio)
+  // Print the $property and return the value from the Modular Scale function
+  #{$property}: modular-scale($multiple, $base-size, $ratio)
+
+// Classes Mixin
+=modular-scale-classes($multiple, $property)
+
+  // Loop from 0 through the value of $multiple and generate a range of classes
+  @for $i from 0 through $multiple
+    .#{$class-slug}-#{$i}
+      +modular-scale($property, $i)

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: modular-scale
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Kellum
+- Adam Stacoviak
+- Mason Wendell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: compass
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.11.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+description: Modular Scale calculates the incremental values of the modular scale.
+email: 
+- scott@treesaver.net
+- adam@stacoviak.com
+- mason@zivtech.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.mdown
+- lib/modular-scale.rb
+- stylesheets/_modular-scale.sass
+homepage: https://github.com/scottkellum/modular-scale
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2151708732276106384
+      segments: 
+      - 0
+      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.8.7
+signing_key: 
+specification_version: 3
+summary: 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: []
+