compass-rgbapng 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 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,71 @@
+# rgbapng - Compass plugin
+
+rgbapng is a Compass plugin for providing cross browser compatible RGBA support. It works by creating single pixel transparent PNGs on the fly for browsers that don't support RGBA. It uses the pure Ruby ChunkyPNG library resulting in hassle-free installation and deployment, and increased performance.
+
+## Installation
+
+Installation is simple via Ruby Gems. [Compass](http://compass-style.org/) and [ChunkyPNG](http://github.com/wvanbergen/chunky_png) are required.
+
+    gem install compass-rgbapng
+
+## Using rgbapng with your Compass project
+
+To use rgbapng with your project, require the plugin from your Compass configuration:
+
+    require "rgbapng"
+
+And then import the mixins to your SASS/SCSS files:
+
+    @import "rgbapng";
+
+### Configurable variables
+
+There is a single variable that defines the path to which your PNG images will be saved. This defaults to `rgbapng` inside your Compass images directory. Change the path globally with:
+
+    $rgbapng_path: 'my_pngs';
+
+### Mixins
+
+There are two mixins available to you.
+
+#### rgba-background($color, [$path])
+
+Sets the background property to use the RGBA value, falling back to the compiled PNG.
+
+    @include rgba-background(rgba(0,0,0,0.75));
+
+Compiles to:
+
+    background: url('/images/rgbapng/000000bf.png?1282127952');
+    background: rgba(0, 0, 0, 0.75);
+
+#### rgba-background-inline($color)
+
+Sets the background property to use the RGBA value, falling back to a base64 encoded image data.
+
+    @include rgba-background-inline(rgba(0,0,0,0.75));
+
+Compiles to:
+
+    background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR4nGNh2A8AAM4AxOSyusMAAAAASUVORK5CYII=');
+    background: rgba(0, 0, 0, 0.75);
+
+### Functions
+
+There are two `Sass::Script` functions which can be used in your SASS:
+
+    # Creates the single pixel PNG image
+    # Returns a String of the image path and filename
+    png_pixelate(color, [dir])
+    
+    # Returns a String of the base64 encoded image data
+    png_base64(color)
+
+## Credit where it's due
+
+* The CSS technique used was initially described by Lea Verou in [Bulletproof, cross-browser RGBA backgrounds, today](http://leaverou.me/2009/02/bulletproof-cross-browser-rgba-backgrounds/).
+* The SASS functions were [first created by Benjamin Doherty](http://gist.github.com/377912) using the RMagick library.
+
+## Copyright
+
+Copyright (c) 2010 [Aaron Russell](http://www.aaronrussell.co.uk/). See LICENSE for details.

data/lib/rgbapng.rb

@@ -0,0 +1,6 @@
+require "rgbapng/functions"
+
+Compass::Frameworks.register("rgbapng",
+  :stylesheets_directory  => File.join(File.dirname(__FILE__), "stylesheets"),
+  :templates_directory    => File.join(File.dirname(__FILE__), "templates")
+)

data/lib/rgbapng/functions.rb

@@ -0,0 +1,33 @@
+require "rubygems"
+require "chunky_png"
+require "base64"
+
+module Sass::Script::Functions
+  
+  def png_pixelate(c, dir = "rgbapng")
+    color = ChunkyPNG::Color.rgba(c.red, c.green, c.blue, (c.alpha * 100 * 2.55).round)
+    image = ChunkyPNG::Image.new(1,1, color)
+    dir   = dir.is_a?(Sass::Script::String) ? dir.value : dir
+    file  = File.join(dir, ChunkyPNG::Color.to_hex(color).gsub(/^#/, "") + ".png")
+    path = File.join(Compass.configuration.images_path, file)
+        
+    if !File.exists?(path) || options[:force]
+      puts "Writing #{file}"
+      [Compass.configuration.images_path, File.join(Compass.configuration.images_path, dir)].each do |d|
+        Dir.mkdir(d) unless File.exists?(d)        
+      end
+      image.save(path)
+    end
+    
+    Sass::Script::String.new(file)
+  end
+
+  def png_base64(c)
+    color = ChunkyPNG::Color.rgba(c.red, c.green, c.blue, (c.alpha * 100 * 2.55).round)
+    image = ChunkyPNG::Image.new(1,1, color)
+    data  = Base64.encode64(image.to_blob).gsub("\n", "")
+    
+    Sass::Script::String.new("url('data:image/png;base64,#{data}')")
+  end
+  
+end

data/lib/stylesheets/_rgbapng.scss

@@ -0,0 +1,12 @@
+$rgbapng_path: 'rgbapng';
+
+@mixin rgba-background($color, $dir:$rgbapng_path){
+  background: image_url(png_pixelate($color, $dir));
+  background: $color;
+}
+
+@mixin rgba-background-inline($color){
+  background: png_base64($color);
+  background: $color;
+}
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: compass-rgbapng
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Russell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-18 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: compass
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: chunky_png
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 0
+        version: 0.8.0
+  type: :runtime
+  version_requirements: *id002
+description: Compass plugin for providing cross-browser compatible RGBA support by creating transparent PNGs on the fly for browsers that don't support RGBA. Uses the pure Ruby ChunkyPNG library for hassle free install and deployment and increased performance.
+email: aaron@gc4.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- lib/rgbapng/functions.rb
+- lib/rgbapng.rb
+- lib/stylesheets/_rgbapng.scss
+has_rdoc: false
+homepage: http://github.com/aaronrussell/compass-rgbapng
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Compass plugin for providing cross-browser compatible RGBA support by creating transparent PNGs on the fly for browsers that don't support RGBA.
+test_files: []
+