compass-fontcustom 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09fd173b97e0decca5edd88875fa5933a0563fbf
-  data.tar.gz: 5aa0dd9935ab4fc1d858ffa79f6069243230addf
+  metadata.gz: cb0812751debead28ea3d4591379fee7e0583fbc
+  data.tar.gz: 029b22c2336088adab8a978424fc3010ea114544
 SHA512:
-  metadata.gz: 5927c5e83d08a64cb9c374174a03700b18a9546a1798e84377515d0cf9b6f3ee72f26ac0ab2691b8d2658afeff14d73772a3a41f94c609a0a2af33a70819b872
-  data.tar.gz: 6dbb765920258fafc1bcb9e804e2f7e3a383577cf2cc4d1fb09f7fc89a4f72293de09563e243ce7edb777cbbd7d417e3662f22e6fe7e1a6c1205e2c79e633c2d
+  metadata.gz: 2902fae6a25bde6f8943acecdb39e2ea5dc7d85e4f2a1724c23bc2517cb1ff04b60901ad8f585ef5907e67ef09ff45aab27c47f20eb1f241827dc5008257b406
+  data.tar.gz: 985c8f266cd4c3833e54cedd7c01259893977627a4564c801dc635f74e45274b5baa991459051736c9bc4f69a81719d032fabecdfdfca1255fa16bfb4b136041

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+**1.2.0** Major release
+
+ - Bundles Fontcustom 1.2.0
+ - **Compatibility**: CSS class name and glyph name normalization have been decoupled. See the readme for details.
+ - Extended documentation in the readme.
+
 **1.1.0** Minor release
 
  - Bundles Fontcustom 1.1.0

data/README.md

@@ -9,7 +9,8 @@ This is my attempt of integrating [Font Custom](http://fontcustom.com) with [Com
 
 ## Requirements
 
-Made for ruby 1.9+. Tested on 1.9.3 and 2.0.0.
+Made for ruby 1.9+. Tested on 1.9.3 and 2.0.0.  
+You'll need to have fontforge and the [WOFF font toolset](http://people.mozilla.com/~jkew/woff) installed as outlined in the Font Custom [installation instructions](http://fontcustom.com/#installation).
 
 ## Installation
 
@@ -35,14 +36,39 @@ You can let Font Custom generate your fonts upon Compass' css compilation:
 @include all-myfont-glyphs;
 ```
 
-This will import `fontcustom.css` into your stylesheet so that you can use the font `myfont` and the generated classes.
+This will setup a proper `@font-face` and generate icon classes named `.icon-<font_name>-<glyph_name>` for each glyph.
 
-The font files will be searched in `images_path/myfont` and be written to Compass' `fonts_path`.
+### Custom class names
 
-## Disabling file name hashes
+You can also use custom class names using the `<font_name>-glyph()` mixin:
 
-You can choose to disable file name hashes if you're already using an asset pipeline that handles this for you:
-Use the `fontcustom_hash` compass option in `config.rb`
+```css
+.custom-class-name {
+  @include myfont-glyph(glyph-file-name);
+}
+```
+
+which will result into CSS along the lines of:
+
+```css
+.myfont-font, .custom-class-name {
+  font-family: "myfont";
+}
+.custom-class-name:before {
+  content: "\f100";
+}
+```
+
+> **Attention**  
+> Generated CSS class names will be normalized and reserved characters removed.  
+> That means if you have a glyph file name of `a_R3ally-eXotic f1Le+Name.svg` the generated class name will be `.icon-myfont-a_R3ally-eXotic-f1Le-Name`.
+
+## Configuration options
+
+### Filename hashing
+
+You can choose to disable file name hashes if you're already using an asset pipeline which handles this for you:
+Use the `fontcustom_hash` option in `config.rb`
 
 ```ruby
 compass_config do |config|

data/compass-fontcustom.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 1.9.3'
 
   spec.add_dependency "compass"
-  spec.add_dependency "fontcustom", "~> 1.1.0"
+  spec.add_dependency "fontcustom", "~> 1.2.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/compass/fontcustom/font_importer.rb

@@ -69,7 +69,7 @@ module Compass
             raise Compass::SpriteException, %Q{No glyph images were found matching "#{uri}" in the images path. Your current images path is: #{folder}}
           end
 
-          files.map { |f| File.basename(f)[0..-5].gsub(/[^0-9A-Za-z]/, '') }
+          files.map { |f| File.basename(f)[0..-5] }
         end
 
         # Returns `Sass::Engine` options with defaults

data/lib/compass/fontcustom/glyph_map.rb

@@ -15,7 +15,7 @@ module Compass
 
         # TODO: improve extraction of aboslute path
         path = File.dirname glyphs.first
-        glyphs.map! { |file| File.basename(file)[0..-5].gsub(/[^0-9A-Za-z]/, '') }
+        glyphs.map! { |file| File.basename(file)[0..-5] }
 
         new glyphs, path, name, context
       end

data/lib/compass/fontcustom/sass_extensions.rb

@@ -78,6 +78,12 @@ module Compass
           font_url(font_file).value
         end
 
+        def sanitize_symbol(name)
+          sanitized = name.value.to_s.gsub(/[.+{};]+/, ' ').strip.gsub(/[ ]+/, '-')
+          Sass::Script::String.new sanitized
+        end
+        Sass::Script::Functions.declare :sanitize_symbol, [:name]
+
       end
 
     end

data/lib/compass/fontcustom/version.rb

@@ -1,5 +1,5 @@
 module Compass
   module Fontcustom
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/stylesheets/_fontcustom.scss

@@ -18,7 +18,7 @@
   @each $glyph-name in $glyph-names {
 
     $index: index($glyph-names, $glyph-name);
-    $class_name: "icon-#{$name}-#{$glyph-name}";
+    $class_name: "icon-#{$name}-#{sanitize-symbol($glyph-name)}";
 
     .#{$class_name} {
       @if $base-class { @extend #{$base-class}; }

data/test/unit/font_importer_test.rb

@@ -70,6 +70,8 @@ class FontImporterTest < Test::Unit::TestCase
     assert css =~ %r{.#{fontname}-font}, "base font class missing"
     assert css =~ %r{.icon-#{fontname}-c}i, "icon c css class missing"
     assert css =~ %r{.icon-#{fontname}-d}i, "icon d css class missing"
+    assert css =~ %r{.icon-#{fontname}-a_R3ally-eXotic-f1Le-Name}i, "exotic name css class missing"
+    assert css =~ %r{.icon-#{fontname}-google}i, "google icon css class missing"
   end
 
   def test_glyph_mixin
@@ -82,13 +84,13 @@ class FontImporterTest < Test::Unit::TestCase
       @include fontcustom-font-face($myfont-glyphs);
 
       .custom-class-name {
-        @include myfont-glyph(C);
+        @include myfont-glyph('a_R3ally-eXotic f1Le Name');
       }
     SCSS
 
     assert css =~ %r{.#{fontname}-font, .custom-class-name}, "extending base class missing"
     assert css =~ %r{@font-face}, "font-face definition missing"
-    assert css =~ %r{.custom-class-name:before}, "cusom class missing missing"
+    assert css =~ %r{.custom-class-name:before}, "custom class missing missing"
   end
 
 end

data/test/unit/glyph_map_test.rb

@@ -16,10 +16,4 @@ class GlyphMapTest < Test::Unit::TestCase
     assert_equal 0, @glyph_map.index_for_glyph('C')
   end
 
-  def test_glyph_name_normalization
-    glyphs = @glyph_map.instance_variable_get(:@glyphs)
-    assert ! glyphs.include?('google+')
-    assert glyphs.include?('google')
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compass-fontcustom
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - glaszig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: compass
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement