sass-fontimage 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+test/scss/output
+test/output
+test/scss/*.css
+test/scss/**/*.css
+.sass-cache/

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p125@sass-fontimage

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,12 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rmagick (2.13.1)
+    sass (3.1.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rmagick
+  sass

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Flurin Egger, DigitPaint (http://www.digitpaint.nl)
+ 
+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,31 @@
+# Sass-FontImage
+
+A small extension for SASS that generates images for icon fonts. This makes it easy to use an image font with `:before` and `:after` in browser that support and let's you generate the images on the fly for
+browser who don't
+
+## Usage
+
+We use sass from our custom build script so we add the Rack plugin ourselves. We currently don't support the default `sass` executable.
+
+Setting up Sass-FontImage with the Rack plugin: 
+
+    # This must be done AFTER you require 'sass/plugin/rack'
+    require 'sass-fontimage'
+    
+    # ... 
+    
+    # Configure the path where sass-fontimage should write the images
+    # the path MUST exist.    
+    Sass::Plugin.options[:custom] ||= {}    
+    Sass::Plugin.options[:custom][:font_image_location] = "./html/images/fonts"
+
+## Syntax
+
+    background: font_image(CHARACTER, FONTSIZE, COLOR,  RELATIVE_PATH_TO_FONT)
+
+### Example
+
+    background: font_image("\E006", 16px, #f00,  "../fonts/testfont-regular.ttf")
+
+## Copyright & license
+Copyright (c) 2012 Flurin Egger, DigitPaint, MIT Style License. (see MIT-LICENSE)

data/lib/sass-fontimage.rb

@@ -0,0 +1,15 @@
+require "rubygems"
+require "bundler/setup"
+
+require 'pathname'
+require 'rmagick'
+
+# initialize module namespace
+module SassFontimage; end
+
+
+require_relative "sass_fontimage/font_image"
+
+if defined?(Sass)
+  require_relative "sass_fontimage/sass_extensions"
+end

data/lib/sass_fontimage/font_image.rb

@@ -0,0 +1,107 @@
+class SassFontimage::FontImage
+  
+  # @param font String Path to a font (one that RMagick can use)
+  # @param options Options string
+  #
+  # @option options size Integer Default font size
+  # @option options color String Default color  
+  # @option options :write_path The path to write the icon to with write (default = "")
+  # @option options :file_prefix Prefix to use for filename (default = icon)
+  # @option options :file_type Extension to use when writing file (default = png)
+  def initialize(font, options = {})
+    @font = Pathname.new(font)
+    
+    raise ArgumentError, "Font '#{font}' not found on disk" unless File.exist?(font)
+    
+    defaults = {
+      :size => 16, 
+      :color => "#000000",
+      :write_path => "",
+      :file_prefix => "icon",
+      :file_type => "png"
+    }
+    @options = defaults.update(options)
+  end
+  
+  # Renders a character on a RMagick canvas
+  #
+  # @see SassFontimage::FontImage#write
+  # 
+  # @return Magick::Image the image with the charactor drawn.
+  def render(char, color = @options[:color], size = @options[:size])
+    img = Magick::Image.new(size.to_i, size.to_i, Magick::HatchFill.new('transparent', 'transparent'))
+
+    draw = Magick::Draw.new
+
+    char = convert_to_unicode(char)
+    
+    draw.font = @font.to_s
+    draw.interline_spacing = 0
+    draw.pointsize = size.to_i
+    draw.gravity = Magick::CenterGravity
+    draw.fill = color
+    draw.text_antialias = true
+
+    draw.annotate(img, 0, 0, 0, 0, char)
+    
+    img
+  end
+  
+  # Writes the character out to a image file. 
+  # 
+  # The resulting filename has the following format:
+  # PREFIX-SIZExSIZE-COLOR-HEXCODEPOINT.FILETYPE
+  #
+  # Example:
+  # icon-16x16-000000-f001.png
+  # 
+  # 
+  # @param char String A one character string, can also be a CSS encoded value (\0000)
+  # @param color String An optional color, takes default value otherwise
+  # @param size Integer An optional fontsize
+  # 
+  # @return String The path of the written image
+  def write(char, color = @options[:color], size = @options[:size])
+    path = image_path(char, color, size)
+    
+    # Let's not regenerate the same image if the font hasn't changed
+    return path if(path.exist? && @font.mtime <= path.mtime)
+    
+    img = self.render(char, color, size)
+    
+    img.write(path.to_s) do
+      self.format = "PNG32"
+    end 
+    
+    path
+  end
+  
+  protected
+  
+  def image_path(char,color,size)
+    filename = []
+    filename << @options[:file_prefix]
+    filename << "#{size}x#{size}"
+    filename << color.gsub(/[^a-z0-9_]/i, "")
+    filename << convert_to_unicode(char).codepoints.first.to_s(16)
+    
+    filename = filename.join("-") + "." + @options[:file_type]
+    
+    path = Pathname.new(@options[:write_path]) + filename
+  end
+  
+  # Converts css escape to true unicode char
+  # also validates if it's truly only one character
+  def convert_to_unicode(char)
+    
+    if char =~ /\A\\/
+      char = char.gsub("\\","") # Fix double escaping
+      char = [char[0..-1].to_i(16)].pack("U")
+    end
+    
+    raise ArgumentError, "You can only pass one character" if char.size > 1
+    
+    char
+  end
+  
+end

data/lib/sass_fontimage/sass_extensions.rb

@@ -0,0 +1,14 @@
+# Stub module
+module SassFontimage::SassExtensions; end
+       
+require_relative "sass_extensions/font_image_generator"
+require_relative "sass_extensions/functions"
+
+module Sass::Script::Functions
+  include SassFontimage::SassExtensions::Functions
+end
+
+# Wierd that this has to be re-included to pick up sub-modules. Ruby bug?
+class Sass::Script::Functions::EvaluationContext
+  include Sass::Script::Functions
+end

data/lib/sass_fontimage/sass_extensions/font_image_generator.rb

@@ -0,0 +1,115 @@
+require 'fileutils'
+
+class SassFontimage::SassExtensions::FontImageGenerator < Sass::Script::Literal
+  
+  class << self
+    
+    def get(font, env)
+      @cache ||= {}      
+      
+      font = font.value
+      
+      # Stupid cache mechanism, doesn't normalize paths
+      return @cache[env][font] if @cache[env] && @cache[env].respond_to?(:[]) && @cache[env][font]
+      
+      @cache[env] ||= {}
+      @cache[env][font] = self.new(font, env)
+      
+    end
+    
+    def find_font(file, env)
+      load_paths = env.options[:load_paths].map{|p| Pathname.new(p.to_s) }
+          
+      # Escape glob patterns
+      file.gsub(/[\*\[\]\{\}\?]/) do |char|
+        "\\#{char}"
+      end    
+    
+      file = Pathname.new(file)
+      
+      load_paths.each do |p|
+        path = file.absolute? ? file : p + file
+        if full_path = Dir[path.to_s].first
+          return Pathname.new(full_path)
+        end
+      end
+    
+      Pathname.new("")
+    end
+    
+    
+  end
+  
+  def initialize(font, env)
+    # @kwargs = kwargs
+    @environment = env    
+    @font = font
+    @path = self.class.find_font(font, env)
+    
+    fontname = @path.basename.to_s.split(".")[0..-2].join(".")
+    write_path = self.font_image_location + fontname
+    
+    unless write_path.directory?
+      FileUtils.mkdir(write_path)
+    end
+    
+    @fontimage = SassFontimage::FontImage.new(@path, { :write_path => write_path })
+  end
+  
+  def to_s(kwargs = self.kwargs)
+    ""
+  end
+  
+  def value
+    self
+  end
+  
+  # Generate the file if needed
+  def generate(char, size, color)
+    color = "#" + color.rgb.map{|f| f.to_s(16).rjust(2, "0") }.join()
+    path = @fontimage.write(char.value, color, size.to_i)
+    font_image_url(path)
+  end
+
+  def respond_to?(meth)
+    super || @environment.respond_to?(meth)
+  end
+
+  def method_missing(meth, *args, &block)
+    if @environment.respond_to?(meth)
+      @environment.send(meth, *args, &block)
+    else
+      super
+    end
+  end
+  
+  def font_image_url(path)
+    
+    url = []
+    if  @environment.options[:custom] &&  @environment.options[:custom][:font_image_url]
+      url <<  @environment.options[:custom][:font_image_url]
+      url << path.to_s
+      url.join("/").squeeze("/")
+    elsif @environment.options[:css_location]
+      base = Pathname.new(@environment.options[:css_location])
+      path.relative_path_from(base)
+    end
+
+    
+    
+  end
+  
+  
+  def font_image_location
+    if @environment.options[:custom] && @environment.options[:custom][:font_image_location]
+      dir = Pathname.new(@environment.options[:custom][:font_image_location])
+      raise "Directory :font_image_location ('#{dir}') does not seem to be a directory" unless dir.directory?
+      dir
+    else
+      ""
+    end
+  end
+  
+  
+
+end

data/lib/sass_fontimage/sass_extensions/functions.rb

@@ -0,0 +1,23 @@
+# The actual sass extension
+# 
+# It has two configuration parameters that can be passed with the SASS custom
+# configuration parameters.
+#
+# :font_image_location is the base path to write the generated images to
+# :font_image_url is the base url for the directory where all font images reside, by default it's relative to the :css_location path of SASS.
+module SassFontimage::SassExtensions::Functions
+  
+  # Actually generate the font image
+  #
+  # @param [String] char The character to generate
+  # @param [Size] size Size in pixels (can be css value like 16px)
+  # @param [Color] color Color in hex, rgba
+  # @param [String] font Path to font within configuration root
+  def font_image(char, size, color, font)
+    generator = SassFontimage::SassExtensions::FontImageGenerator.get(font, self)
+    image_url = generator.generate(char, size, color)
+    
+    Sass::Script::String.new("url(#{image_url})")
+  end
+
+end

data/sass-fontimage.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+Gem::Specification.new do |s|
+  s.name = "sass-fontimage"
+  s.version = "0.1.0"
+  s.authors = ["Digitpaint"]
+  s.email = %q{info@digitpaint.nl}
+  s.homepage = %q{http://github.com/digitpaint/sass-fontimage}  
+  s.description = %q{A small extension for SASS that generates images from icon fonts}
+  s.summary = %q{A small extension for SASS that generates images from icon fonts}
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.require_paths = ["lib"]  
+  
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  
+  s.files         = `git ls-files --exclude=.gitignore --exclude-standard`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  
+  s.add_dependency "rmagick"
+  s.add_dependency "sass"
+end
+

data/test/sass_test.rb

@@ -0,0 +1,33 @@
+require File.dirname(File.expand_path(__FILE__)) + "/../lib/sass-fontimage.rb"
+
+require 'sass'
+require 'sass/plugin'
+
+require File.dirname(File.expand_path(__FILE__)) + "/../lib/sass_fontimage/sass_extensions.rb"
+
+OUT_PATH = Pathname.new(File.dirname(__FILE__)) + "out"
+
+scss = <<EOS
+$f : font_for_images("test/fonts/testfont-regular.ttf");
+
+#main {
+  background: font_image("\\E006", 16px, #f00,  $f)
+}
+EOS
+
+# engine = Sass::Engine.new(scss, :syntax => :scss)
+# puts engine.render
+
+Sass::Plugin.options[:style] = :expanded
+Sass::Plugin.options[:template_location] = File.dirname(__FILE__) + "/scss"
+Sass::Plugin.options[:css_location] = File.dirname(__FILE__) + "/scss"
+Sass::Plugin.options[:custom] ||= {}
+Sass::Plugin.options[:custom][:font_image_location] = File.dirname(__FILE__) + "/output"
+# Sass::Plugin.options[:custom][:font_image_url] = ""
+Sass::Plugin.options[:always_update] = true
+
+# compiler = Sass::Plugin::Compiler.new()
+
+Sass::Plugin.update_stylesheets()
+
+

data/test/scss/general.scss

@@ -0,0 +1,5 @@
+@import "src/sub";
+
+#main {
+  background: font_image("\\E006", 16px, #f00,  "../fonts/testfont-regular.ttf")
+}

data/test/scss/src/_sub.scss

@@ -0,0 +1,5 @@
+/* Sub file */
+
+#sub {
+  background: font_image("\\E006", 16px, #f00,  "../fonts/testfont-regular.ttf")
+}

data/test/test.rb

@@ -0,0 +1,10 @@
+require File.dirname(File.expand_path(__FILE__)) + "/../lib/sass-fontimage.rb"
+
+FONT_PATH = Pathname.new(File.dirname(__FILE__)) + "fonts/testfont-regular.ttf"
+FONT_SIZE = 16
+FONT_COLOR = "#000000"
+CHAR = "_"
+
+s = SassFontimage::FontImage.new(FONT_PATH)
+
+s.write("\\E006")

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: sass-fontimage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Digitpaint
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A small extension for SASS that generates images from icon fonts
+email: info@digitpaint.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- MIT_LICENSE
+- README.md
+- lib/sass-fontimage.rb
+- lib/sass_fontimage/font_image.rb
+- lib/sass_fontimage/sass_extensions.rb
+- lib/sass_fontimage/sass_extensions/font_image_generator.rb
+- lib/sass_fontimage/sass_extensions/functions.rb
+- sass-fontimage.gemspec
+- test/fonts/testfont-regular.otf
+- test/fonts/testfont-regular.ttf
+- test/sass_test.rb
+- test/scss/general.scss
+- test/scss/src/_sub.scss
+- test/test.rb
+homepage: http://github.com/digitpaint/sass-fontimage
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: A small extension for SASS that generates images from icon fonts
+test_files:
+- test/fonts/testfont-regular.otf
+- test/fonts/testfont-regular.ttf
+- test/sass_test.rb
+- test/scss/general.scss
+- test/scss/src/_sub.scss
+- test/test.rb