compass-vgrid-plugin 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Aaron Russell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# vGrid - Compass plugin
+
+vGrid is a Compass compatible SASS port of the [Variable Grid System](http://www.spry-soft.com/grids/) by SprySoft. Provides fixed, fluid and elastic grids and complete control over the grid system.
+
+The original Variable Grid System is based heavily on the [960 Grid System](http://960.gs/) by Nathan Smith, and then the [Fluid 960 Grid System](http://www.designinfluences.com/fluid960gs/) by Design Influences.
+
+This Compass plugin is written and maintained by [Aaron Russell](http://www.aaronrussell.co.uk/) and borrows heavily from Chris Eppsteins original [SASS port](http://github.com/chriseppstein/compass-960-plugin) of 960.gs.
+
+## Installation
+
+Installation is simple via Ruby Gems. [Compass](http://compass-style.org/) is required.
+
+    sudo gem install compass-vgrid-plugin
+
+## Create a vGrid-based Compass project
+
+To create a vGrid-based compass project simply:
+
+    compass -r vgrid -f <framework> <project name>
+
+vGrid provides three seperate framework options:
+
+* `fixed` - Fixed width grid
+* `fluid` - Fluid width grid
+* `elastic` - Elastic width grid (framework still in development)
+
+## Using vGrid with an existing project
+
+To use vGrid with an existing project simply import the required framework to your SASS. For example:
+
+    @import vgrid/fixed.sass
+
+or
+
+    @import vgrid/fluid.sass
+
+## Creating a grid system
+
+To create the default CSS classes provided by the Variable Grid System simply use the `+grid_system` mixin. Optionally you can pass the number of columns of your layout to the mixin (defaults to 12):
+
+    // Creates a 24 column grid system
+    +grid_system(24)
+
+## vGrid variables
+
+Typically, you will want to customize your grid system. vGrid provides a number of variables which can be set to alter the grid system:
+
+* `!vgrid_width` - The width of the grid system. Defaults to `960px`. Not used with `fluid` framework.
+* `!vgrid_columns` - The number of columns in the grid system. Defaults to `12`.
+* `!vgrid_gutter` - The width of each column gutter. Defaults to `20px`. Not used with `fluid` framework.
+
+## Making semantic grids
+
+It's preferable not to use meaningless class names in your HTML markup. A better solution is to mix the styles from the grid system in with your semantic IDs and classes. vGrid provides a number mixins to allow this:
+
+* `+grid_container` - Declares a container element.
+* `+grid` - Declares a grid element.
+* `+alpha` & `+omega` - Removes the left and right margins from the grid element.
+* `+grid_prefix` & `+grid_suffix` - Adds columns before or after the grid element.
+* `+grid_push` & `+grid_pull` - As above but for absolutely positioned grid elements.
+* `+clearfix` - Clears floated elements.
+
+For example:
+
+    !vgrid_columns = 16
+    
+    #wrap
+      +grid_container
+      #header, #footer
+        +grid(16)
+      #left-nav
+        +grid(5)
+      #main-content
+        +grid_prefix(1)
+        +grid(10)
+
+## Copyright
+
+Copyright (c) 2010 [Aaron Russell](http://www.aaronrussell.co.uk/). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "compass-vgrid-plugin"
+    gem.summary = %Q{Compass compatible SASS port of the Variable Grid System. Based on the 960 Grid System.}
+    gem.description = %Q{A Compass compatible SASS port of the Variable Grid System by Spry Soft (http://www.spry-soft.com/grids/). Based in the 960 Grid System (http://960.gs/). Provides fixed, fluid and elastic grids with complete control over the grid system.}
+    gem.email = "aaron@gc4.co.uk"
+    gem.homepage = "http://github.com/aaronrussell/compass-vgrid-plugin"
+    gem.authors = ["Aaron Russell"]
+    gem.add_dependency "compass", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/compass-vgrid-plugin.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{compass-vgrid-plugin}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Russell"]
+  s.date = %q{2010-01-10}
+  s.description = %q{A Compass compatible SASS port of the Variable Grid System by Spry Soft (http://www.spry-soft.com/grids/). Based in the 960 Grid System (http://960.gs/). Provides fixed, fluid and elastic grids with complete control over the grid system.}
+  s.email = %q{aaron@gc4.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "compass-vgrid-plugin.gemspec",
+     "lib/vgrid.rb",
+     "lib/vgrid/compass_plugin.rb",
+     "sass/vgrid/_elastic.sass",
+     "sass/vgrid/_fixed.sass",
+     "sass/vgrid/_fluid.sass",
+     "sass/vgrid/shared/_grid_system.sass",
+     "templates/elastic/project/grid.sass",
+     "templates/elastic/project/manifest.rb",
+     "templates/fixed/project/grid.sass",
+     "templates/fixed/project/manifest.rb",
+     "templates/fluid/project/grid.sass",
+     "templates/fluid/project/manifest.rb"
+  ]
+  s.homepage = %q{http://github.com/aaronrussell/compass-vgrid-plugin}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Compass compatible SASS port of the Variable Grid System. Based on the 960 Grid System.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<compass>, [">= 0"])
+    else
+      s.add_dependency(%q<compass>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<compass>, [">= 0"])
+  end
+end
+

data/lib/vgrid/compass_plugin.rb

@@ -0,0 +1,7 @@
+["fixed", "fluid", "elastic"].each do |framework|
+  options = {
+    :stylesheets_directory => File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sass')),
+    :templates_directory => File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'templates', framework))
+  }
+  Compass::Frameworks.register(framework, options)
+end

data/lib/vgrid.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'vgrid', 'compass_plugin')

data/sass/vgrid/_fixed.sass

@@ -0,0 +1,60 @@
+=grid_container
+  :margin-left auto
+  :margin-right auto
+  :width= !vgrid_width
+ 
+=grid_width(!n, !cols = !vgrid_columns, !gutter_width = !vgrid_gutter)
+  :width= (!vgrid_width / !cols) * !n - !gutter_width
+ 
+=grid_unit_base(!gutter_width = !vgrid_gutter)
+  :display inline
+  :float left
+  :position relative
+  :margin
+    :left= !gutter_width / 2
+    :right= !gutter_width / 2
+ 
+=grid(!n, !cols = !vgrid_columns, !gutter_width = !vgrid_gutter)
+  +grid_unit_base(!gutter_width)
+  +grid_width(!n, !cols, !gutter_width)
+ 
+=grids(!cols = !vgrid_columns, !gutter_width = !vgrid_gutter)
+  #{enumerate(".grid", 1, !cols, "_")}
+    +grid_unit_base
+  @for !n from 1 through !cols
+    .container_#{!cols} .grid_#{!n}
+      +grid_width(!n, !cols, !gutter_width)
+ 
+=grid_prefix(!n, !cols = !vgrid_columns)
+  :padding-left= (!vgrid_width / !cols) * !n
+ 
+=grid_prefixes(!cols = !vgrid_columns)
+  @for !n from 1 through !cols - 1
+    .container_#{!cols} .prefix_#{!n}
+      +grid_prefix(!n, !cols)
+ 
+=grid_suffix(!n, !cols = !vgrid_columns)
+  :padding-right= (!vgrid_width / !cols) * !n
+ 
+=grid_suffixes(!cols = !vgrid_columns)
+  @for !n from 1 through !cols - 1
+    .container_#{!cols} .suffix_#{!n}
+      +grid_suffix(!n, !cols)
+
+=grid_push(!n, !cols = !vgrid_columns)
+  :left= (!vgrid_width / !cols) * !n
+
+=grid_pushes(!cols = !vgrid_columns)
+  @for !n from 1 through !cols - 1
+    .container_#{!cols} .push_#{!n}
+      +grid_push(!n, !cols)
+
+=grid_pull(!n, !cols = !vgrid_columns)
+  :right= (!vgrid_width / !cols) * !n * -1
+
+=grid_pulls(!cols = !vgrid_columns)
+  @for !n from 1 through !cols - 1
+    .container_#{!cols} .pull_#{!n}
+      +grid_pull(!n, !cols)
+
+@import vgrid/shared/grid_system.sass

data/sass/vgrid/_fluid.sass

@@ -0,0 +1,60 @@
+=grid_container
+  :margin-left 4%
+  :margin-right 4%
+  :width= 92%
+ 
+=grid_width(!n, !cols = !vgrid_columns)
+  :width= (100% / !cols) * !n - 2%
+ 
+=grid_unit_base
+  :display inline
+  :float left
+  :position relative
+  :margin
+    :left= 1%
+    :right= 1%
+ 
+=grid(!n, !cols = !vgrid_columns)
+  +grid_unit_base
+  +grid_width(!n, !cols)
+ 
+=grids(!cols = !vgrid_columns)
+  #{enumerate(".grid", 1, !cols, "_")}
+    +grid_unit_base
+  @for !n from 1 through !cols
+    .container_#{!cols} .grid_#{!n}
+      +grid_width(!n, !cols)
+ 
+=grid_prefix(!n, !cols = !vgrid_columns)
+  :padding-left= (100% / !cols) * !n
+ 
+=grid_prefixes(!cols = !vgrid_columns)
+  @for !n from 1 through !cols - 1
+    .container_#{!cols} .prefix_#{!n}
+      +grid_prefix(!n, !cols)
+ 
+=grid_suffix(!n, !cols = !vgrid_columns)
+  :padding-right= (100% / !cols) * !n
+ 
+=grid_suffixes(!cols = !vgrid_columns)
+  @for !n from 1 through !cols - 1
+    .container_#{!cols} .suffix_#{!n}
+      +grid_suffix(!n, !cols)
+
+=grid_push(!n, !cols = !vgrid_columns)
+  :left= (100% / !cols) * !n
+
+=grid_pushes(!cols = !vgrid_columns)
+  @for !n from 1 through !cols - 1
+    .container_#{!cols} .push_#{!n}
+      +grid_push(!n, !cols)
+
+=grid_pull(!n, !cols = !vgrid_columns)
+  :right= (100% / !cols) * !n * -1
+
+=grid_pulls(!cols = !vgrid_columns)
+  @for !n from 1 through !cols - 1
+    .container_#{!cols} .pull_#{!n}
+      +grid_pull(!n, !cols)
+ 
+@import vgrid/shared/grid_system.sass

data/sass/vgrid/shared/_grid_system.sass

@@ -0,0 +1,45 @@
+@import compass/utilities/general/clearfix.sass
+
+!vgrid_width ||= 960px
+!vgrid_columns ||= 12
+!vgrid_gutter ||= 20px
+
+=alpha
+  :margin-left 0
+ 
+=omega
+  :margin-right 0
+
+=grid_children
+  .alpha
+    +alpha
+  .omega
+    +omega
+
+=grid_system(!cols = !vgrid_columns)
+  /*
+    Containers
+  .container_#{!cols}
+    +grid_container
+  /*
+    Grid
+  +grids(!cols)
+  /*
+    Grid >> Children (Alpha ~ First, Omega ~ Last)
+  +grid_children
+  /*
+    Prefix Extra Space
+  +grid_prefixes(!cols)
+  /*
+    Suffix Extra Space
+  +grid_suffixes(!cols)
+  /*
+    Push Space
+  +grid_pushes(!cols)
+  /*
+    Pull Space
+  +grid_pulls(!cols)
+  /*
+    Clear Floated Elements
+  .clearfix
+    +clearfix

data/templates/elastic/project/grid.sass

@@ -0,0 +1,2 @@
+/*
+  The vGrid Elastic framework is still in development. Look out for version 0.3.

data/templates/elastic/project/manifest.rb

@@ -0,0 +1 @@
+stylesheet "grid.sass", :media => "screen, projection"

data/templates/fixed/project/grid.sass

@@ -0,0 +1,25 @@
+/*
+  Variable Grid System.
+  Learn more ~ http://www.spry-soft.com/grids/
+  Based on 960 Grid System - http://960.gs/
+  Licensed under GPL and MIT.
+  Converted to Compass compatible plugin by Aaron Russell - http://www.aaronrussell.co.uk
+ 
+@import vgrid/fixed.sass
+ 
+// The following generates the default grids provided by the css version of Variable Grid System
++grid_system(12)
+ 
+// But most compass users prefer to construct semantic layouts like so (two column layout with header and footer):
+!vgrid_columns = 16
+#wrap
+  +grid_container
+  #header, #footer
+    +grid(16)
+  #left-nav
+    +grid(5)
+  #main-content
+    +grid_prefix(1)
+    +grid(10)
+
+// When in doubt, try a +clearfix mixin ;)

data/templates/fixed/project/manifest.rb

@@ -0,0 +1 @@
+stylesheet "grid.sass", :media => "screen, projection"

data/templates/fluid/project/grid.sass

@@ -0,0 +1,25 @@
+/*
+  Variable Grid System (Fluid Version).
+  Learn more ~ http://www.spry-soft.com/grids/
+  Based on 960 Grid System - http://960.gs/ & 960 Fluid - http://www.designinfluences.com/
+  Licensed under GPL and MIT.
+  Converted to Compass compatible plugin by Aaron Russell - http://www.aaronrussell.co.uk
+ 
+@import vgrid/fluid.sass
+ 
+// The following generates the default grids provided by the css version of Variable Grid System
++grid_system(12)
+  
+// But most compass users prefer to construct semantic layouts like so (two column layout with header and footer):
+!vgrid_columns = 16
+#wrap
+  +grid_container
+  #header, #footer
+    +grid(16)
+  #left-nav
+    +grid(5)
+  #main-content
+    +grid_prefix(1)
+    +grid(10)
+ 
+// When in doubt, try a +clearfix mixin ;)

data/templates/fluid/project/manifest.rb

@@ -0,0 +1 @@
+stylesheet "grid.sass", :media => "screen, projection"

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: compass-vgrid-plugin
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Aaron Russell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-10 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: compass
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A Compass compatible SASS port of the Variable Grid System by Spry Soft (http://www.spry-soft.com/grids/). Based in the 960 Grid System (http://960.gs/). Provides fixed, fluid and elastic grids with complete control over the grid system.
+email: aaron@gc4.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- compass-vgrid-plugin.gemspec
+- lib/vgrid.rb
+- lib/vgrid/compass_plugin.rb
+- sass/vgrid/_elastic.sass
+- sass/vgrid/_fixed.sass
+- sass/vgrid/_fluid.sass
+- sass/vgrid/shared/_grid_system.sass
+- templates/elastic/project/grid.sass
+- templates/elastic/project/manifest.rb
+- templates/fixed/project/grid.sass
+- templates/fixed/project/manifest.rb
+- templates/fluid/project/grid.sass
+- templates/fluid/project/manifest.rb
+has_rdoc: true
+homepage: http://github.com/aaronrussell/compass-vgrid-plugin
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Compass compatible SASS port of the Variable Grid System. Based on the 960 Grid System.
+test_files: []
+