compass-fontcustom 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea8fcaf8c9cf900531ee2cac60cc449e8a00ede5
-  data.tar.gz: fbaa31bc881a18dd35e367311ffc77abe4d66e33
+  metadata.gz: ebb1130d663a53b726f45e3259849477a741fea4
+  data.tar.gz: af69d9bad9a3e45454f9a7239730206d37a7ba04
 SHA512:
-  metadata.gz: 4e1095302fad3596b4b5d8c5ed102888f3188375730fa93fc604f17f94412f09e58f6fb939071149a236ac64fd1a5a16f432ff245f170d0bff4b1477577ac868
-  data.tar.gz: 45ac78f054e80a76419ea92665a25141ce58f5669b0eae8a79e1446bb004b1d58de243697b7d018798095484ced1b13d1accaa299fe723125360f656c5cb50b2
+  metadata.gz: f98cc4f1877cf321100f66c06ff06e0bda8771f01a78bebb55ad3555f9a4f199dc65fb138417c25add27b5bc7866cf63b66ab3e90acae53f911e4cb2276a3967
+  data.tar.gz: db70ce3ef495da6710cb8d5a1f0c5dc1c426af0afba8432c0469068423ab67bad16345d5d2d56735bb3141b97afa8b4df4897362f860cd30eb735c5b91a49e49

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+**1.3.1** Minor release
+
+ - Use FontCustom's codepoints when regenerating fonts to add/remove glyphs -- #19
+ - Fixed an issue picking up the wrong font filename -- #18
+ - Dropped Ruby 1.9 support
+ - Testing on all Ruby 2.x versions
+ - Deprecated options `fontcustom_fonts_path` in favor of `fontcustom_options`
+
 **1.3.0** Major release
 
  - Bundles Fontcustom 1.3.0 -- #10

data/Gemfile

@@ -6,6 +6,6 @@ gemspec
 gem 'coveralls', :require => false
 group :development do
 	gem 'autotest-standalone'
-	gem 'autotest-growl' if RUBY_PLATFORM =~ /darwin/
-	gem 'autotest-fsevent', '>= 0.2.9'
+	gem 'autotest-fsevent'
+  gem 'travis'
 end

data/README.md

@@ -3,14 +3,12 @@
 [![Build Status](https://travis-ci.org/glaszig/compass-fontcustom.png?branch=master)](https://travis-ci.org/glaszig/compass-fontcustom)
 [![Gem Version](https://badge.fury.io/rb/compass-fontcustom.png)](http://badge.fury.io/rb/compass-fontcustom)
 [![Test Coverage](https://coveralls.io/repos/glaszig/compass-fontcustom/badge.png?branch=master)](https://coveralls.io/r/glaszig/compass-fontcustom)
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/glaszig/compass-fontcustom/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-[![endorse](https://api.coderwall.com/glaszig/endorsecount.png)](https://coderwall.com/glaszig)
 
 This is my attempt of integrating [Font Custom](http://fontcustom.com) with [Compass](http://compass-style.org).
 
 ## Requirements
 
-Made for ruby 1.9+. Tested on 1.9.3, 2.0.0 and 2.1.3.  
+Tested on Ruby 2.0, 2.1, 2.2, 2.3 and 2.4.  
 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
@@ -32,12 +30,12 @@ And then execute:
 Compass::Fontcustom adds the following configuration options to Compass.  
 Just add these to your project's `config/compass.rb`.
 
-- `fontcustom_hash`  
-  Enables/disables Fontcustom file name hashing.
 - `fontcustom_input_paths`  
   Array of paths where to search for SVG files to build custom fonts from.
-- `fontcustom_fonts_path`  
-  Path to put generated font files in.
+- `fontcustom_discard_manifest`  
+  Boolean to configure to delete the manifest file after each run.
+- `fontcustom_options`  
+  A hash to pass native options to FontCustom.
 
 ## Usage
 

data/Rakefile

@@ -5,6 +5,7 @@ Rake::TestTask.new do |t|
  t.libs << 'test'
  t.test_files = FileList['test/**/*_test.rb']
  t.verbose = true
+ t.warning = false
 end
 
 desc "Run tests"

data/compass-fontcustom.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0'
 
   spec.add_dependency "compass", "~> 1.0.1"
   spec.add_dependency "fontcustom", "~> 1.3.3"
 
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "test-unit"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
 end

data/lib/compass/fontcustom.rb

@@ -1,9 +1,12 @@
 require "compass"
 require "compass/fontcustom/version"
+require "compass/fontcustom/util"
 require "compass/fontcustom/compass"
 require "compass/fontcustom/sass_extensions"
 require "compass/fontcustom/glyph_map"
 require "compass/fontcustom/font_importer"
+require "compass/fontcustom/patches"
+require "compass/fontcustom/deprecations"
 
 module Compass
 	# This module registers the gem as a Compass framework source,
@@ -12,10 +15,6 @@ module Compass
     base_directory  = File.expand_path('../../../', __FILE__)
     Compass::Frameworks.register('fontcustom', :path => base_directory)
 
-    Compass::Configuration.add_configuration_property(:fontcustom_hash, "enables/disables fontcustom file name hashing") do
-      true
-    end
-
     Compass::Configuration.add_configuration_property(:fontcustom_input_paths, "Array of paths where to search for SVG files to build custom fonts from") do
       if defined? Rails
         Rails.application.config.assets.paths
@@ -24,8 +23,16 @@ module Compass
       end
     end
 
-    Compass::Configuration.add_configuration_property(:fontcustom_fonts_path, "Path to put generated font files in") do
-      Compass.configuration.fonts_path.to_s
+    Compass::Configuration.add_configuration_property(:fontcustom_fonts_path, "(Deprecated) Path to put generated font files in")
+
+    Compass::Configuration.add_configuration_property(:fontcustom_options,
+      'Options passed to fontcustom when generating fonts') do
+      {}
+    end
+
+    Compass::Configuration.add_configuration_property(:fontcustom_discard_manifest,
+      'Remove manifest each time after fonts are compiled') do
+      false
     end
 
     Sass.load_paths << FontImporter.new

data/lib/compass/fontcustom/deprecations.rb

@@ -0,0 +1,16 @@
+module Compass
+  module Fontcustom
+    module Deprecations
+      def fontcustom_fonts_path= value
+        warn "WARNING: fontcustom_fonts_path is deprecated. Prefer to use Compass' fonts_path."
+        super
+      end
+
+      [ Compass::Configuration::FileData,
+        Compass::Configuration::Data
+      ].each do |m|
+        m.send :include, Deprecations
+      end
+    end
+  end
+end

data/lib/compass/fontcustom/font_importer.rb

@@ -136,6 +136,11 @@ module Compass
         nil
       end
 
+      # Unused
+      def public_url(*args)
+        nil
+      end
+
       # Unused. Just returns nil.
       def find_relative(uri, base, options)
         nil

data/lib/compass/fontcustom/glyph_map.rb

@@ -39,38 +39,34 @@ module Compass
 
       # Starts the Fontcustom font generator to write font files to disk.
       def generate
-        args = self.class.config.generator_options || {}
-        args.merge!(
-          :input     => path,
-          :output    => output_dir,
-          :font_name => @name,
-          :no_hash   => !Compass.configuration.fontcustom_hash,
-          :quiet     => true,
-          :fonts     => []
-        )
-        ::Fontcustom::Base.new(args).compile
+        args = (self.class.config.generator_options || {}).
+          merge(output: output_dir, quiet: true, fonts: []).
+          merge(Compass.configuration.fontcustom_options).
+          merge(font_name: @name, input: path)
+        @fontcustom = ::Fontcustom::Base.new(args)
+        @fontcustom.compile
+        File.delete(@fontcustom.manifest.manifest) if Compass.configuration.fontcustom_discard_manifest
       end
 
-      def filename
-        file = glob.first
-        File.basename file, File.extname(file)
+      def fonts
+        if @fontcustom
+          @fontcustom.manifest.get(:fonts).each_with_object({}) do |font, result|
+            result[File.extname(font)[1..-1].to_sym] = font
+          end
+        end
       end
 
-      def output_dir
-        Compass.configuration.fontcustom_fonts_path
+      def glyphs
+        @fontcustom.manifest.get :glyphs
       end
 
       def to_s
         @name.to_s
       end
 
-      protected
-
-        def glob
-          glob = File.join output_dir, "#{self.name}*"
-          Dir[glob]
-        end
-
+      def output_dir
+        Compass.configuration.fontcustom_fonts_path || Compass.configuration.fonts_path
+      end
     end
   end
 end

data/lib/compass/fontcustom/patches.rb

@@ -0,0 +1,3 @@
+class Fontcustom::Base
+   attr_accessor :manifest
+end

data/lib/compass/fontcustom/sass_extensions.rb

@@ -8,21 +8,22 @@ module Compass
 
         # Font type format mappings used in css font-face declarations.
         # @see #glyph_font_sources
-        FONT_TYPE_FORMATS = {
-          'eot?#iefix'       => 'embedded-opentype',
-          'woff'             => 'woff',
-          'ttf'              => 'truetype',
-          "svg#%{font_name}" => 'svg'
+        FONT_TYPE_OPTIONS = {
+          eot: {format: 'embedded-opentype', postfix: '?#iefix'},
+          woff: {format: 'woff'},
+          ttf: {format: 'truetype'},
+          svg: {format: 'svg', postfix: '#%{font_name}'}
         }
 
         # Returns `:before` pseudo class styles for the letter at `index` of the font.
         #
-        # @param index [FixNum] the font's index
+        # @param map [Compass::Fontcustom::GlyphMap] a glyph map
+        # @param glyph [String] glyph name
         # @return [Sass::Script::String]
-        def glyph(index)
-          idx = (61696+index.value-1).to_s(16)
-          css = %Q[&:before { content: "\\#{idx}"; }]
-          Sass::Script::String.new %Q["\\#{idx}"]
+        def glyph(map, glyph)
+          # Name transform should be implemented as in FontCustom
+          glyph = map.glyphs[Util.sanitize_symbol(glyph).to_sym]
+          Sass::Script::String.new "'\\#{glyph[:codepoint]}'"
         end
         Sass::Script::Functions.declare :letter, [:index]
 
@@ -42,9 +43,14 @@ module Compass
         def glyph_font_sources(map)
           map.generate
           src = []
-          FONT_TYPE_FORMATS.each do |type, format|
-            url = glyph_font_type_url map, type
-            src << "#{url} format('#{format}')"
+
+          fonts = map.fonts
+
+          FONT_TYPE_OPTIONS.each do |font_type, options|
+            if font = fonts[font_type]
+              url = glyph_font_type_url("#{font}#{options[:postfix]}" % {font_name: map.name})
+              src << "#{url} format('#{options[:format]}')"
+            end
           end
           Sass::Script::String.new src.join ", "
         end
@@ -71,16 +77,13 @@ module Compass
         # Helper method. Returns a `Sass::Script::Functions#font_url for the font of `type` in `map`.
         #
         # @return [String]
-        def glyph_font_type_url(map, type)
-          type = type % {font_name: map.name}
-          file_name = "#{map.filename}.#{type}"
-          font_file = Sass::Script::String.new file_name
+        def glyph_font_type_url(file_path)
+          font_file = Sass::Script::String.new File.basename(file_path)
           font_url(font_file).value
         end
 
         def sanitize_symbol(name)
-          sanitized = name.value.to_s.gsub(/[.+{};]+/, ' ').strip.gsub(/[ ]+/, '-')
-          Sass::Script::String.new sanitized
+          Sass::Script::String.new Util.sanitize_symbol name.value
         end
         Sass::Script::Functions.declare :sanitize_symbol, [:name]
 

data/lib/compass/fontcustom/templates/stylesheet.scss.erb

@@ -15,6 +15,5 @@ $<%= name %>-glyphs: glyph-map("<%= uri %>");
 
 @mixin <%= name %>-glyph($glyph-name) {
   @extend #{$<%= name %>-font-base-class};
-  $index: index(<%= glyph_names.map{ |g| "'#{g}'" }.join " " %>, $glyph-name);
-  &:before { content: glyph($index); }
+  &:before { content: glyph($<%= name %>-glyphs, $glyph-name); }
 }

data/lib/compass/fontcustom/util.rb

@@ -0,0 +1,13 @@
+module Compass
+  module Fontcustom
+    module Util
+      class << self
+        def sanitize_symbol name
+          name.to_s.gsub(/^"|"$/,    '') \
+                   .gsub(/[.+{};]+/, ' ') \
+                   .gsub(/[ ]+/,     '-')
+        end
+      end
+    end
+  end
+end

data/lib/compass/fontcustom/version.rb

@@ -1,5 +1,5 @@
 module Compass
   module Fontcustom
-    VERSION = "1.3.0"
+    VERSION = "1.3.1"
   end
 end

data/stylesheets/_fontcustom.scss

@@ -16,14 +16,11 @@
 @mixin glyphs($map, $glyph-names, $base-class: false) {
   $name: glyph-font-name($map);
   @each $glyph-name in $glyph-names {
-
-    $index: index($glyph-names, $glyph-name);
     $class_name: "icon-#{$name}-#{sanitize-symbol($glyph-name)}";
 
     .#{$class_name} {
       @if $base-class { @extend #{$base-class}; }
-      &:before { content: glyph($index); }
+      &:before { content: glyph($map, $glyph-name); }
     }
-
   }
 }

data/test/unit/font_importer_test.rb

@@ -18,9 +18,11 @@ class FontImporterTest < Test::Unit::TestCase
     SCSS
     Compass.add_configuration(config, "fontcustom_config")
 
-    Compass::Fontcustom::GlyphMap.configure do |config|
-      config.generator_options = { :debug => false }
+    Compass::Fontcustom::GlyphMap.configure do |c|
+      c.generator_options = { :debug => false }
     end
+
+    Compass.configuration.fontcustom_options = {}
   end
 
   def teardown
@@ -57,16 +59,16 @@ class FontImporterTest < Test::Unit::TestCase
   def test_should_skip_file_name_hashes_if_option_is_set
     fontname = 'myfont'
 
-    Compass.configuration.fontcustom_hash = false
+    Compass.configuration.fontcustom_options[:no_hash] = true
 
     css = render <<-SCSS
       @import "#{fontname}/*.svg";
       @include all-myfont-glyphs;
     SCSS
 
-    assert File.exists? File.join(Compass.configuration.fonts_path, 'myfont.svg')
-    assert File.exists? File.join(Compass.configuration.fonts_path, 'myfont.ttf')
-    assert File.exists? File.join(Compass.configuration.fonts_path, 'myfont.woff')
+    assert File.exist? File.join(Compass.configuration.fonts_path, 'myfont.svg')
+    assert File.exist? File.join(Compass.configuration.fonts_path, 'myfont.ttf')
+    assert File.exist? File.join(Compass.configuration.fonts_path, 'myfont.woff')
 
     assert css =~ %r{.#{fontname}-font}, "base font class missing"
     assert css =~ %r{.icon-#{fontname}-c}i, "icon c css class missing"
@@ -78,7 +80,7 @@ class FontImporterTest < Test::Unit::TestCase
   def test_glyph_mixin
     fontname = 'myfont'
 
-    Compass.configuration.fontcustom_hash = false
+    Compass.configuration.fontcustom_options[:no_hash] = true
 
     css = render <<-SCSS
       @import "#{fontname}/*.svg";

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compass-fontcustom
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - glaszig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: compass
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -96,10 +110,13 @@ files:
 - lib/compass/fontcustom.rb
 - lib/compass/fontcustom/compass.rb
 - lib/compass/fontcustom/configurable.rb
+- lib/compass/fontcustom/deprecations.rb
 - lib/compass/fontcustom/font_importer.rb
 - lib/compass/fontcustom/glyph_map.rb
+- lib/compass/fontcustom/patches.rb
 - lib/compass/fontcustom/sass_extensions.rb
 - lib/compass/fontcustom/templates/stylesheet.scss.erb
+- lib/compass/fontcustom/util.rb
 - lib/compass/fontcustom/version.rb
 - stylesheets/_fontcustom.scss
 - test/fixtures/myfont/C.svg
@@ -121,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -129,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Integrates Fontcustom with Compass