fontastic2sass 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb468deae4baf15a019bc0233f3646c65a908679
+  data.tar.gz: c05b43d68f048a571d6533f24ab97197a24abd98
+SHA512:
+  metadata.gz: 1576aedf8ee7c5fd0910917e4a72bcbe99c04f6290fef5194bf601afb7a0269414d7145bbe50360d7e7310ac65f9b67f7b0f470edf080be72e9e436c21ce3a1a
+  data.tar.gz: 2b0b731e45ee4dc741f00912949756c8e4ecf6e959ecdf7ccb76516984e3befe962ce3c896c4c8c28cb0f172fca546fa3fc2601562027f8daa6d3d32e320bab0

data/bin/fontastic2sass

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+require 'run'

data/lib/fontastic2sass/archive.rb

@@ -0,0 +1,23 @@
+class Fontastic2Sass::Archive
+  attr_reader :files
+
+  EXTRACTABLE_PATTERN = /(fonts\/.*|styles\.css|icons-reference\.html)/
+
+  def font_files
+    @_font_files ||= @files.reject {|key| !key.match(/fonts/) }
+  end
+
+  def metadata_file
+    @_metadata_file ||= @files.reject {|key| !key.match(/styles.css/) }.values.first
+  end
+
+  def demo_files
+    @_demo_files ||= begin
+      demo_files = @files.reject {|key| !key.match(/(\.html|\.css)/) }
+      demo_files['demo-files/style.css'] = demo_files.delete('styles.css')
+      demo_files
+    end
+  end
+
+end
+

data/lib/fontastic2sass/cli.rb

@@ -0,0 +1,31 @@
+require 'thor'
+require 'thor/group'
+require 'fontastic2sass'
+
+class Fontastic2Sass::CLI < Thor::Group
+  include Thor::Actions
+
+  argument :source
+
+  class_option :'font-path', type: :string, default: './', desc: 'Destination path for font files'
+  class_option :'sass-path', type: :string, default: './', desc: 'Destination path for Sass files'
+  class_option :scss, type: :boolean, default: false, desc: 'Use the SCSS syntax'
+  class_option :compatible, aliases: '-c', type: :boolean, default: false, desc: 'Generate code compatible with Sass 3.2'
+  class_option :oocss, type: :boolean, default: false, desc: 'Generate OOCSS-style classes'
+  class_option :'demo-path', type: :string, default: false, desc: 'Destination path for demo.html'
+
+  def start
+
+    begin
+      Fontastic2Sass.run! source, options['font-path'], options['sass-path'], options
+
+    rescue Exception => e
+      say_status(e, '', :red)
+
+    end
+
+    return
+
+  end
+end
+

data/lib/fontastic2sass/dir.rb

@@ -0,0 +1,21 @@
+class Fontastic2Sass::Dir < Fontastic2Sass::Archive
+
+  def initialize(directory)
+    @files = {}
+
+    Dir.glob("#{directory}/**/*", File::FNM_DOTMATCH) do |file|
+      next if ['.','..','.DS_Store'].include? file
+
+      @files[file.sub("#{directory}/", '')] = File.read(file) if extractable? file
+    end
+
+  end
+
+  private
+
+    def extractable?(entry)
+      return EXTRACTABLE_PATTERN.match(entry) && File.file?(entry)
+    end
+
+end
+

data/lib/fontastic2sass/font.rb

@@ -0,0 +1,24 @@
+class Fontastic2Sass::Font
+  attr_reader :font_family
+
+  def initialize(file)
+    @font_family = file.scan(/font-family\: \"(.+)\"/).first.first
+
+    @raw_icons = file.scan(/\.icon-(.+)\:.+{\s+content\: \"(.+)\"/)
+  end
+
+  def icons
+    @icons ||= begin
+      icons = {}
+
+      @raw_icons.each do |icon|
+        icons[icon.first] = {
+          codepoint: icon.last
+        }
+      end
+
+      icons
+    end
+  end
+end
+

data/lib/fontastic2sass/sass.rb

@@ -0,0 +1,42 @@
+require 'erb'
+require 'sass'
+
+class Fontastic2Sass::Sass
+  attr_reader :code, :syntax
+
+  def initialize(font, syntax = 'sass', compatible = false)
+    @font = font
+    @syntax = syntax
+    
+    @format = compatible ? 'list' : 'map'
+    
+    @code = sass_convert 'sass', syntax, template(@format)
+  end
+
+  def oocss
+    sass_convert 'sass', syntax, template("oocss_#{@format}")
+  end
+
+  private
+
+    def template(tmpl)
+      icons = @font.icons
+      font_family = @font.font_family
+
+      renderer = ERB.new File.read("#{File.dirname(__FILE__)}/templates/#{tmpl}.sass.erb")
+      renderer.result(binding)
+    end
+
+
+    def sass_convert(from_syntax, to_syntax, sass)
+      return sass if from_syntax == to_syntax
+
+      begin
+        Sass::Engine.new(sass, {:from => from_syntax.to_sym, :to => to_syntax.to_sym, :syntax => from_syntax.to_sym}).to_tree.send("to_#{to_syntax}").chomp
+      rescue Sass::SyntaxError => e
+        sass
+      end
+    end
+
+end
+

data/lib/fontastic2sass/templates/list.sass.erb

@@ -0,0 +1,27 @@
+// This file was generated with fontastic2sass. (https://github.com/jedfoster/fontastic2sass)
+// You may lose edits if you run fontastic2sass again.
+
+<% icons.each do |icon, content|
+%>$<%= "#{icon}-icon: \'#{content[:codepoint]}\'" %>
+<% end %>
+
+%icon-pseudo-content
+  font-family: '<%= font_family %>'
+  speak: none
+  font-style: normal
+  font-weight: normal
+  font-variant: normal
+  text-transform: none
+  line-height: 1
+
+  // Better Font Rendering
+  -webkit-font-smoothing: antialiased
+  -moz-osx-font-smoothing: grayscale
+
+<% icons.each do |icon, content| %>
+<%= "%#{icon}-icon" %>
+  @extend %icon-pseudo-content
+
+  content: <%= "$#{icon}-icon" %>
+<% end %>
+

data/lib/fontastic2sass/templates/map.sass.erb

@@ -0,0 +1,51 @@
+$icons: ( <%=
+  list = []
+  icons.each do |icon, contents|
+    list.push "#{icon}: '#{contents[:codepoint]}'"
+  end
+
+  list.join(", ")
+%> )
+
+
+///**
+// * Allows you to access an individual icon by name.
+// *
+// * @param {String} $name - name of icon
+// *
+// * @example scss
+// * .foo {
+// *   content: icon(github);
+// * }
+// *
+// * @return {String | Null}
+// */
+@function icon($name)
+  @return map-get($icons, $name)
+
+
+// This file was generated with fontastic2sass. (https://github.com/jedfoster/fontastic2sass)
+// You may lose edits if you run fontastic2sass again.
+
+%icon-pseudo-content
+  font-family: '<%= font_family %>'
+  speak: none
+  font-style: normal
+  font-weight: normal
+  font-variant: normal
+  text-transform: none
+  line-height: 1
+  vertical-align: middle
+
+  // Better Font Rendering
+  -webkit-font-smoothing: antialiased
+  -moz-osx-font-smoothing: grayscale
+
+
+@each $placeholder, $content in $icons
+  %#{$placeholder}-icon
+    @extend %icon-pseudo-content
+
+    @each $value in $content
+      content: $value
+

data/lib/fontastic2sass/templates/oocss_list.sass.erb

@@ -0,0 +1,7 @@
+// This file was generated with fontastic2sass. (https://github.com/jedfoster/fontastic2sass)
+// You may lose edits if you run fontastic2sass again.
+
+<% icons.each do |icon, content| %>
+<%= ".#{icon}-icon" %>:before
+  @extend %<%= "#{icon}-icon" %>
+<% end %>

data/lib/fontastic2sass/templates/oocss_map.sass.erb

@@ -0,0 +1,6 @@
+// This file was generated with fontastic2sass. (https://github.com/jedfoster/fontastic2sass)
+// You may lose edits if you run fontastic2sass again.
+
+@each $placeholder, $content in $icons
+  .#{$placeholder}-icon:before
+    @extend %#{$placeholder}-icon

data/lib/fontastic2sass/utilities.rb

@@ -0,0 +1,9 @@
+require 'thor'
+
+module Fontastic2Sass
+  
+  class Utilities < Thor
+    include Thor::Actions
+  end
+
+end

data/lib/fontastic2sass/version.rb

@@ -0,0 +1,4 @@
+module Fontastic2Sass
+  VERSION = '1.0.0'
+end
+

data/lib/fontastic2sass/zip.rb

@@ -0,0 +1,22 @@
+require 'zip'
+
+class Fontastic2Sass::Zip < Fontastic2Sass::Archive
+
+  def initialize(zip_file)
+    @files = {}
+
+    Zip::File.open(zip_file) do |z|
+      z.each do |entry|
+        @files[entry.name] = z.get_input_stream(entry).read if extractable? entry
+      end
+    end
+  end
+
+  private
+
+    def extractable?(entry)
+      return EXTRACTABLE_PATTERN.match(entry.name) && entry.ftype == :file
+    end
+
+end
+

data/lib/fontastic2sass.rb

@@ -0,0 +1,72 @@
+require 'fontastic2sass/version'
+require 'fontastic2sass/archive'
+require 'fontastic2sass/zip'
+require 'fontastic2sass/dir'
+require 'fontastic2sass/font'
+require 'fontastic2sass/sass'
+require 'fontastic2sass/utilities'
+require 'hash'
+
+
+module Fontastic2Sass
+
+  def self.run!(source, font_path, sass_path, options = {})
+    defaults = {
+      scss: false,
+      compatible: false,
+      oocss: false,
+      demo_path: options[:"demo-path"]
+    }
+
+    options = defaults.merge options.symbolize_keys
+
+    utilities = Fontastic2Sass::Utilities.new
+
+    if source.end_with? '.zip'
+      files = Fontastic2Sass::Zip.new source
+
+    elsif ::Dir.exists? source
+      files = Fontastic2Sass::Dir.new source
+
+    else
+      raise 'Source must be either a directory or .zip file!'
+
+    end
+
+    # raise 'Source must contain \'selection.json\'.' unless files.files['selection.json']
+
+    font = Fontastic2Sass::Font.new files.metadata_file
+
+    syntax = options[:scss] ? 'scss' : 'sass'
+
+    compatible = options[:compatible] || false
+
+    sass = Fontastic2Sass::Sass.new font, syntax, compatible
+
+
+    # Save the Sass file
+    utilities.create_file "#{sass_path}/_icons.#{sass.syntax}", sass.code
+
+    if options[:oocss]
+      utilities.create_file "#{sass_path}/_oocss_icons.#{sass.syntax}", sass.oocss
+    end
+
+    files.font_files.each do |filename, content|
+      utilities.create_file "#{font_path}/#{filename.sub('fonts/', '')}", content
+    end
+
+    if options[:demo_path]
+      files.demo_files.each do |filename, content|
+        utilities.create_file "#{options[:demo_path]}/#{filename}", content
+      end
+
+      files.font_files.each do |filename, content|
+        utilities.create_file "#{options[:demo_path]}/demo-files/fonts/#{filename.sub('fonts/', '')}", content
+      end
+
+      utilities.gsub_file "#{options[:demo_path]}/icons-reference.html", /href="styles.css">/, 'href="demo-files/styles.css">'
+    end
+  end
+
+end
+

data/lib/hash.rb

@@ -0,0 +1,26 @@
+class Hash
+  def transform_keys
+    result = {}
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+
+  def transform_keys!
+    keys.each do |key|
+      self[yield(key)] = delete(key)
+    end
+    self
+  end
+
+  def symbolize_keys
+    transform_keys{ |key| key.to_sym rescue key }
+  end
+
+  def symbolize_keys!
+    transform_keys!{ |key| key.to_sym rescue key }
+  end
+
+end
+

data/lib/run.rb

@@ -0,0 +1,96 @@
+require 'fontastic2sass/cli'
+
+
+ARGV << '--help' if ARGV.empty?
+
+
+help_message = <<-EOT
+Usage: fontastic2sass path/to/fontastic(.zip) [OPTIONS]
+
+You can also pass the path to an unzipped directory.
+
+
+OPTIONS
+  --font-path PATH      Destination path for font files, defaults to current directory
+  --sass-path PATH      Destination path for Sass files, defaults to current directory
+  --scss                Use the SCSS syntax
+  -c, --compatible      Generate code compatible with Sass 3.2
+  --oocss               Generate OOCSS-style classes
+  --demo-path PATH      Copy demo.html from SOURCE to PATH/demo.html
+                        If omitted, the demo file will be ignored
+
+
+OUTPUT
+  By default fontastic2sass generates Sass code in the indented Sass syntax. Further,
+  the default generated code is only compatible with Sass 3.3+.
+
+    $icons: (
+        github: \'\\28\',
+        twitter: \'\\29\',
+        gear: \'\\e002\',
+        ...
+    )
+
+    @each $placeholder, $content in $icons
+      %\#{$placeholder}-icon
+        @each $value in $content
+          content: $value
+
+  Sass 3.2 doesn't support hash-like maps, so if you're still using 3.2, you'll need
+  to set the '-c' flag, which will generate code like this:
+
+    $github-icon: \'\\28\'
+    $twitter-icon: \'\\29\'
+    $gear-icon: \'\\e002\'
+
+    ...
+
+    %github-icon
+      content: $github-icon
+
+    %twitter-icon
+      content: $twitter-icon
+
+    %gear-icon
+      content: $gear-icon
+
+OOCSS
+
+  By default, fontastic2sass only generates Sass placeholder selectors. If you need
+  literal CSS classes pass the '--oocss' flag, and fontastic2sass will generate a
+  second Sass file, '_oocss_icons.sass', containing CSS classes for each icon.
+
+    @each $placeholder, $content in $icons
+      .\#{$placeholder}-icon:before
+        @extend %\#{$placeholder}-icon
+
+  Or, for Sass 3.2, something like this:
+
+    .github-icon:before
+      @extend %github-icon
+
+    .twitter-icon:before
+      @extend %twitter-icon
+
+    .gear-icon:before
+      @extend %gear-icon
+EOT
+
+command = ARGV[0]
+
+if !(command.nil? || command == '--help')
+  Fontastic2Sass::CLI.start
+
+
+elsif command == '--help'
+  puts help_message
+
+else
+  puts "Error: Command '#{command}' not recognized"
+  if %x{rake #{command} --dry-run 2>&1 } && $?.success?
+    puts "Did you mean: `$ rake #{command}` ?\n\n"
+  end
+  puts help_message
+  exit(1)
+end
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: fontastic2sass
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jed Foster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Utility for using Fontastic.me icon sets in Sass projects
+email:
+- jed@jedfoster.com
+executables:
+- fontastic2sass
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fontastic2sass/archive.rb
+- lib/fontastic2sass/cli.rb
+- lib/fontastic2sass/dir.rb
+- lib/fontastic2sass/font.rb
+- lib/fontastic2sass/sass.rb
+- lib/fontastic2sass/templates/list.sass.erb
+- lib/fontastic2sass/templates/map.sass.erb
+- lib/fontastic2sass/templates/oocss_list.sass.erb
+- lib/fontastic2sass/templates/oocss_map.sass.erb
+- lib/fontastic2sass/utilities.rb
+- lib/fontastic2sass/version.rb
+- lib/fontastic2sass/zip.rb
+- lib/fontastic2sass.rb
+- lib/hash.rb
+- lib/run.rb
+- bin/fontastic2sass
+homepage: https://github.com/jedfoster/fontastic2sass
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Command line utility that extracts fonts and codepoints from an Fontastic
+  .zip file and generates a Sass file with variables and placholders.
+test_files: []