compass-retinator 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resque-smtp.gemspec
+gemspec

data/README.md

@@ -0,0 +1,83 @@
+## Compass Retinator
+
+This Compass extension will allow you to create retina ready sprites from scratch. Just drop your images on the right folders, type some Compass mumble jumble and you are ready to go!
+
+##Installation
+
+    gem installl compass-retinator
+
+Now do a require in your Compass <kbd>config.rb</kbd>
+
+    require 'compass-retinator'
+
+## How to use it?
+
+Fisrt thing to do is drop your images on the right folders. In this case I have set two folders <kbd>icons</kbd> and <kbd>icons-sprites</kbd> inside my image folder.
+
+Next, we need to tell Compass where those image are. Add this line to <kbd>variables.saas</kbd> or somewhere else
+
+    $sprites:        sprite-map("icons/*.png")
+    $sprites_retina: sprite-map("icons-sprites/*.png")
+
+
+Now we need to init awesomeness, add this line to your project:
+
+    @import "compass-retinator"
+
+## Using the extension
+
+You can pass several parameters to obtain the right result, some valid options are:
+
+  // This will import plain.png
+    .plain
+      +sprite(plain)
+
+    // This will import boat.png, boat_hover.png and boat_active.png
+    .boat
+      +sprite(boat, $hover_state: true, $active_state: true)
+
+    // This will import console.png plus 40px of padding on the sides
+    .console
+      +sprite(console, $spacing: 40px)
+
+    // This will import people.png and it will not set any dimension on this elemments
+    .people
+      +sprite(people, $dimensions: False)
+
+## Commmons Issues
+
+### The sprite position is wrong
+
+Please make you sure that your icons scale proportionally. If the non-retina icons are **16x16** your retina icons must be **32x32** and not **30x32** and definitely not **45x34**
+
+### I'm getting a _compass can't convert nil into string_ error
+
+You probably are running a rails app. This is a weird issue with compass-rails. For some reason compass-rails does not create the sprites on demand and do not understand the `sprite-map`.
+
+One walkaround is to tell Compass to re-declare your sprites assets, so add this line at the top of your variables:
+
+    @import "icons/*.png"
+    @import "icons-sprites/*.png"
+
+### The smart layout doesn't seems to work properly
+
+Unfortunately Compass doesn't support extra options with this layout. Try to use the default layout or the horizontal layout.
+
+### When I add some _spacing_ to my sprite the sprite position is not right
+
+Please keept in mind that if you are adding extra padding around the sprite item you will also need to tell Compass to add some extra space on every sprite item. Just past the varible `$spacing: XXpx`
+
+    $sprites:        sprite-map("icons/*.png", $spacing: 10px)
+    $sprites_retina: sprite-map("icons-sprites/*.png", $spacing: 20px)
+
+## Licence
+
+Copyright (c) 2013 Restorando
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/compass-retinator.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'compass-retinator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "compass-retinator"
+  spec.version       = CompassRetinator::VERSION
+  spec.authors       = ["Restorando"]
+  spec.email         = ["dev@restorando.com"]
+  spec.description   = %q{Easily create sprites that support retina}
+  spec.summary       = %q{Compass plugin to create sprite for retina devices}
+  spec.homepage      = "https://github.com/restorando/compass-retinator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "compass", "~> 0.12.0"
+end

data/example/demo.sass

@@ -0,0 +1,28 @@
+//Add compass
+@import compass
+
+// Compass-Rasils walkaround
+@import "icons/*.png"
+@import "icons-sprites/*.png"
+
+// My sprites
+$sprites:        sprite-map("icons/*.png", $spacing: 10px)
+$sprites_retina: sprite-map("icons-sprites/*.png", $spacing: 20px)
+
+@import compass_retinator
+
+//Create a single button
+.my-button
+  +sprite(my-button)
+
+//Create a single button withhover and active states
+.my-button-2
+  +sprite(my-button-2, $hover_state: true, $active_state: true)
+
+//Create a single button and add 40px of padding around
+.my-button-3
+  +sprite(my-button-3, $spacing: 40px)
+
+//Create a single button with no dimensions by default
+.my-button-4
+  +sprite(my-button-3, $dimensions: false)

data/lib/compass-retinator.rb

@@ -0,0 +1,7 @@
+require 'compass'
+require 'compass-retinator/version'
+
+Compass::Frameworks.register("compass-retinator", :path => "#{File.dirname(__FILE__)}/..")
+
+module CompassRetinator
+end

data/lib/compass-retinator/version.rb

@@ -0,0 +1,5 @@
+module CompassRetinator
+
+  VERSION = "0.1.0"
+
+end

data/stylesheets/_compass_retinator.sass

@@ -0,0 +1,5 @@
+// Hello Compass.
+@import "compass"
+
+// Compass retina sprites
+@import "partials/retinator"

data/stylesheets/partials/_retinator.sass

@@ -0,0 +1,40 @@
+=sprite($item_name, $hover_state: false, $active_state: false, $dimensions: true, $spacing: 0)
+  +retina-sprite($item_name, $sprites, $sprites_retina, $hover_state, $active_state, $dimensions, $spacing)
+
+=retina-sprite($item_name, $sprites, $sprites_retina, $hover_state, $active_state, $dimensions, $spacing)
+  $hover_state:   false !default
+  $active_state:  false !default
+  $dimensions:    true  !default
+  $media-queries: "(-webkit-min-device-pixel-ratio: 1.25), (min-resolution: 120dpi), (-webkit-min-device-pixel-ratio: 1.3), (min-resolution: 124.8dpi), (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi), (-webkit-min-device-pixel-ratio: 2), (min-resolution: 192dpi)"
+
+  background: sprite-url($sprites) sprite-position($sprites, $item_name, $spacing, $spacing) no-repeat
+
+  @if $hover_state
+    $item_name_hover: $item_name + _hover
+    &:hover
+      background-position: sprite-position($sprites, $item_name_hover, $spacing, $spacing)
+      @media #{$media-queries}
+        $item_name_hover: $item_name + _hover
+        $sprite_position: sprite-position($sprites_retina, $item_name_hover, $spacing * 2, $spacing * 2)
+        background-position: nth($sprite_position, 1) /2 nth($sprite_position, 2) / 2
+
+  @if $active_state
+    $item_name_active: $item_name + _active
+    &:active
+      background-position: sprite-position($sprites, $item_name_active, $spacing, $spacing)
+      @media #{$media-queries}
+        $item_name_active: $item_name + _active
+        $sprite_position: sprite-position($sprites_retina, $item_name_active, $spacing * 2, $spacing * 2)
+        background-position: nth($sprite_position, 1) /2 nth($sprite_position, 2) / 2
+
+  @if $spacing > 0
+    padding: $spacing
+
+  @if $dimensions
+    +sprite-dimensions($sprites, $item_name)
+
+  @media #{$media-queries}
+    &
+      $sprite_position: sprite-position($sprites_retina, $item_name, $spacing * 2, $spacing * 2)
+      background: sprite-url($sprites_retina) nth($sprite_position, 1) /2 nth($sprite_position, 2) / 2 no-repeat
+      +background-size(ceil(image-width(sprite-path($sprites_retina)) / 2) auto)

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: compass-retinator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Restorando
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: compass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: Easily create sprites that support retina
+email:
+- dev@restorando.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- compass-retinator.gemspec
+- example/demo.sass
+- lib/compass-retinator.rb
+- lib/compass-retinator/version.rb
+- stylesheets/_compass_retinator.sass
+- stylesheets/partials/_retinator.sass
+homepage: https://github.com/restorando/compass-retinator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Compass plugin to create sprite for retina devices
+test_files: []