hieroglyph 0.1.1 → 0.1.2

data/lib/hieroglyph/assets/header

@@ -5,5 +5,3 @@
 <font id="{{NAME}}" horiz-adv-x="1024" >
 <font-face units-per-em="1024" ascent="819" descent="-205" />
 <missing-glyph horiz-adv-x="500" />
-<glyph d="M0 0h1000v1024h-1000v-1024z" />
-<glyph d="M0 0h1000v1024h-1000v-1024z" />

data/lib/hieroglyph/character_sheet.rb

@@ -1,48 +1,40 @@
 module Hieroglyph
 
-  if rmagick_installed?
-    class CharacterSheet
+  class CharacterSheet
 
-      def initialize(options)
-        @options = options
-        @output_path = File.join(@options[:output_folder], @options[:name]) + "_characters.png"
-        if File.exist? @output_path
-          Hieroglyph.log "  #{@output_path} exists, deleting"
-          File.delete @output_path
-        end
-        @characters = Magick::ImageList.new
-      end
+    attr_accessor :files, :output_path
 
-      def add(file, name)
-        character = Magick::Image::read(file).first
-        character['Label'] = name
-        @characters.push character
-      end 
+    @@montage_args = {
+      'background' => '#ffffff',
+      'fill' => '#000000',
+      'geometry' => '150x150+25+25',
+      'label' => '%t',
+      'mattecolor' => '#ffffff'
+    }
 
-      def save
-        name = @options[:name]
-        img = @characters.montage do
-          self.background_color = "#ffffff"
-          self.border_width = 20
-          self.border_color = "#ffffff"
-          self.fill = "#000000"
-          self.geometry = "150x150+10+5"
-          self.matte_color = "#ffffff"
-          self.title = name
-        end
-        img.write(@output_path)
-      end
+    def initialize(options)
+      @options = options
+      @output_path = File.join(@options[:output_folder], @options[:name]) + '_characters.png'
+      Hieroglyph.delete @output_path
+      @files = []
+      Hieroglyph.log 'ImageMagick detected - generating character sheet'
     end
 
-  else
-    # No-op
-    class CharacterSheet
-      def initialize(*)
-      end
-      def add(file, name)
+    def add(file)
+      @files.push file
+    end
+
+    def save
+      cmd = 'montage'
+      @@montage_args['title'] = @options[:name]
+      @@montage_args.each do |arg, value|
+        cmd << " -#{arg} #{value}"
       end
-      def save
+      @files.each do |file|
+        cmd << " #{file}"
       end
+      cmd << " #{@output_path}"
+      `#{cmd}`
     end
   end
 

data/lib/hieroglyph/command_line.rb

@@ -18,9 +18,17 @@ Options:
       @execute = true
       parse_options
       if @execute
-        Hieroglyph.make @options
-        Hieroglyph.log "", "  Saved to #{@options[:output_folder]}", "", "=== #{@options[:name]} generated ===", ""
-        Hieroglyph.log "To create a full set of webfonts, upload to:", "http://www.fontsquirrel.com/fontface/generator", ""
+        font = Hieroglyph.make @options
+        Hieroglyph.header "#{@options[:name]} generated"
+        Hieroglyph.log "Saved to #{@options[:output_folder]}"
+        Hieroglyph.log "To create a full set of webfonts, upload to:"
+        Hieroglyph.log "http://www.fontsquirrel.com/fontface/generator"
+        Hieroglyph.log
+        Hieroglyph.log "If you're having trouble uploading SVGs, try converting to a TTF first using http://www.freefontconverter.com"
+        Hieroglyph.log
+        Hieroglyph.log "Single characters: #{font.characters.join(',')}"
+        Hieroglyph.log "Unicode characters: #{font.unicode_values.join(',')}"
+        Hieroglyph.log
       end
     end
 

data/lib/hieroglyph/font.rb

@@ -2,40 +2,38 @@ module Hieroglyph
 
   class Font
 
+    attr_accessor :output_path, :options, :characters, :unicode_values, :contents, :character_sheet
+
     def initialize(options)
+      @characters = []
+      @unicode_values = []
+      @contents = ""
       @options = options
       @output_path = File.join(@options[:output_folder], @options[:name] + ".svg")
-      @contents = ""
       setup
       add_glyphs
       finish
     end
 
-    def add_header
-      header_path = File.join(File.dirname(__FILE__), "assets/header")
-      header = File.open(header_path).read
-      header.gsub!("{{NAME}}", @options[:name])
-      add header
-    end 
-
-    def add_footer
-      footer_path = File.join(File.dirname(__FILE__), "assets/footer")
-      footer = File.open(footer_path).read
-      add footer
+    def include(file)
+      path = File.join(File.dirname(__FILE__), "assets/#{file}")
+      add File.open(path).read
     end
 
-    def setup 
-      Hieroglyph.log "", "=== Generating #{@options[:name]} ===", ""
-      if File.exist? @output_path
-        Hieroglyph.log "  #{@output_path} exists, deleting"
-        File.delete @output_path
-      end
-      @character_sheet = CharacterSheet.new(@options)
-      add_header
+    def setup
+      Hieroglyph.header "Generating #{@options[:name]}"
+      Hieroglyph.delete @output_path
+      @character_sheet = Hieroglyph.imagemagick_installed? ? CharacterSheet.new(@options) : NoopSheet.new
+      include 'header'
+    end
+
+    def set_name
+      @contents.gsub!("{{NAME}}", @options[:name])
     end
 
     def finish
-      add_footer
+      include "footer"
+      set_name
       File.open(@output_path, "w") do |file|
         file.puts @contents
         file.close
@@ -48,10 +46,10 @@ module Hieroglyph
     end
 
     def add_glyphs
-      Hieroglyph.log "", "  Reading from #{@options[:glyph_folder]}...", ""
-      Dir.glob(File.join(@options[:glyph_folder], "*.svg")).each do |file|
-        glyph = Glyph.new(file, @options[:glyph_folder])
-        @character_sheet.add(file, glyph.name)
+      Hieroglyph.log
+      Dir.glob(File.join(@options[:glyph_folder], '*.svg')).each do |file|
+        glyph = Glyph.new(file, @options[:glyph_folder], self)
+        @character_sheet.add file
         add glyph.to_node
       end
     end

data/lib/hieroglyph/glyph.rb

@@ -5,19 +5,94 @@ module Hieroglyph
 
   class Glyph
 
-    attr_accessor :name
+    attr_accessor :name, :path, :contents
 
-    def initialize(file, source)
-      @name = file.gsub(source, "").gsub("/", "").each_char.first
-      Hieroglyph.log "    #{@name} -> reading..."
+    SHAPE_HANDLERS = {
+      'circle' => 'report_invalid',
+      'ellipse' => 'report_invalid',
+      'line' => 'report_invalid',
+      'polyline' => 'report_invalid',
+      'rect' => 'report_invalid',
+      'polygon' => 'convert_polygon',
+      'path' => 'convert_path'
+    }
+
+    NAME_REGEX = /^..*?(?=(-|\.))/
+
+    UNICODE_REGEX = /(?<=^&#(x|X)).*(?=;)/
+
+    @@too_many_shapes = false
+
+    def initialize(file, source, font)
+      @font = font
+      set_name(file, source)
       @contents = Nokogiri::XML(File.new(file))
-      @polygon = @contents.root.at_css("polygon")
-      @path = @polygon.nil? ? convert_path: convert_polygon
-      flip_paths
+      Hieroglyph.log "#{@name} -> reading...", 4
+      @path = parse_shapes
+    end
+
+    def set_name(file, source)
+      @name = file.gsub(source, '').gsub('/', '').match(NAME_REGEX).to_s
+      unicode = @name.match(UNICODE_REGEX)
+      if unicode
+        @font.unicode_values.push(unicode.to_s.upcase)
+      else
+        @font.characters.push(@name)
+      end
+    end
+
+    def parse_shapes
+      path = Savage::Path.new
+      count = 0
+      SHAPE_HANDLERS.each do |type, method|
+        contents = @contents.root.at_css(type)
+        if contents
+          count += 1
+          if count > 1
+            report_too_many
+          else
+            path = self.method(method).call(type, contents)
+          end
+        end
+      end
+      path
     end
 
-    def flip_paths
-      @path.subpaths.each do |subpath|
+    def convert_polygon(type, content)
+      Hieroglyph.log "polygon found - converting", 9
+      points = content["points"].split(" ")
+      Savage::Path.new do |path|
+        start_position = points.shift.split(",")
+        path.move_to(start_position[0], start_position[1])
+        points.each do |point|
+          position = point.split(",")
+          path.line_to(position[0], position[1])
+        end
+        path.close_path
+        flip(path)
+      end
+    end
+
+    def convert_path(type, content)
+      Hieroglyph.log 'path found', 9
+      path = Savage::Parser.parse content['d']
+      flip(path)
+    end
+
+    def report_invalid(type, content)
+      Hieroglyph.log "#{type} found - this shape is invalid!", 9
+      Hieroglyph.log "'make compound path' in your vector tool to fix", 9
+    end
+
+    def report_too_many
+      unless @too_many
+        Hieroglyph.log 'too many shapes! your icon might look weird as a result', 9
+        @too_many = true
+      end
+    end
+
+    def flip(path)
+      path.subpaths.each do |subpath|
         subpath.directions.each do |direction|
           case direction
           when Savage::Directions::MoveTo
@@ -55,34 +130,17 @@ module Hieroglyph
           end
         end
       end
-    end
-
-    def convert_path
-      @path = @contents.root.at_css("path")["d"] 
-      @path = Savage::Parser.parse @path
-    end
-
-    def convert_polygon
-      Hieroglyph.log "      -> converting polygon to path"
-      points = @polygon["points"].split(" ")
-      Savage::Path.new do |path|
-        start_position = points.shift.split(",")
-        path.move_to(start_position[0], start_position[1])
-        points.each do |point|
-          position = point.split(",")
-          path.line_to(position[0], position[1])
-        end
-        path.close_path
-      end
+      path
     end
 
     def flip_y(value)
       value = value.to_f
       value = (value - 500) * -1 + 500
+      value = value - 25
     end
 
     def to_node
-      return "<glyph unicode=\"#{@name}\" d=\"#{@path.to_command}\" />\n"
+      @path ? "<glyph unicode=\"#{@name}\" d=\"#{@path.to_command}\" />\n" : ''
     end
 
   end

data/lib/hieroglyph/noop_sheet.rb

@@ -0,0 +1,13 @@
+module Hieroglyph
+
+  class NoopSheet
+    def initialize(*)
+      Hieroglyph.log "ImageMagick not detected - skipping character sheet"
+    end
+    def add(file)
+    end
+    def save
+    end
+  end
+
+end

data/lib/hieroglyph/version.rb

@@ -1,3 +1,3 @@
 module Hieroglyph
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/lib/hieroglyph/character_sheet_spec.rb

@@ -1,49 +1,34 @@
 require 'spec_helper'
 
 describe Hieroglyph::CharacterSheet do
-  context "A CharacterSheet" do
-    before :each do
-      @characters = stub(:push)
-      Magick::ImageList.stubs(:new).returns(@characters)
+  context 'A CharacterSheet' do
 
+    before :each do
+      module Hieroglyph
+        def self.log(*)
+        end
+        def self.header(*)
+        end
+      end
       @character_sheet = Hieroglyph::CharacterSheet.new({:output_folder => '/tmp', :name => 'sheet'})
+      @path = File.expand_path('../../../support/test.svg', __FILE__)
     end
 
-    it "adds a file with a given name" do
-      character = stub(:[]=)
-      Magick::Image.stubs(:read).returns([character])
-
-      @character_sheet.add('a file', 'some name')
+    it 'sets the correct output path' do
+      @character_sheet.output_path.should eql '/tmp/sheet_characters.png'
+    end
 
-      Magick::Image.should have_received(:read).with('a file')
-      character.should have_received(:[]=).with('Label', 'some name')
-      @characters.should have_received(:push).with(character)
+    it 'adds a file with a given name' do
+      puts @path
+      @character_sheet.add(@path)
+      @character_sheet.files.should eql [@path]
     end
 
     it 'saves the files into one image' do
-      image = stub(:write)
-
-      @characters.stubs(:montage).yields.returns(image)
-
-      @character_sheet.stubs(:background_color=)
-      @character_sheet.stubs(:border_width=)
-      @character_sheet.stubs(:border_color=)
-      @character_sheet.stubs(:fill=)
-      @character_sheet.stubs(:geometry=)
-      @character_sheet.stubs(:matte_color=)
-      @character_sheet.stubs(:title=)
-
+      @character_sheet.add(@path)
       @character_sheet.save
-
-      @character_sheet.should have_received(:background_color=).with("#ffffff")
-      @character_sheet.should have_received(:border_width=).with(20)
-      @character_sheet.should have_received(:border_color=).with("#ffffff")
-      @character_sheet.should have_received(:fill=).with("#000000")
-      @character_sheet.should have_received(:geometry=).with("150x150+10+5")
-      @character_sheet.should have_received(:matte_color=).with("#ffffff")
-      @character_sheet.should have_received(:title=).with('sheet')
-
-      image.should have_received(:write).with('/tmp/sheet_characters.png')
+      File.exists?('/tmp/sheet_characters.png').should be_true
+      File.delete('/tmp/sheet_characters.png')
     end
   end
-end
+end

data/spec/lib/hieroglyph/font_spec.rb

@@ -1,5 +1,73 @@
 require 'spec_helper'
 
 describe Hieroglyph::Font do
-  
-end
+  context 'A Font' do
+
+    before :each do
+
+      module Hieroglyph
+        def self.log(*)
+        end
+        def self.header(*)
+        end
+      end
+
+      system('rm -rf /tmp/glyphs/')
+      system('mkdir /tmp/glyphs/')
+      path_to_test = File.expand_path('../../../support/test.svg', __FILE__)
+      system("cp #{path_to_test} /tmp/glyphs/a-test.svg")
+      @font = Hieroglyph::Font.new({:output_folder => '/tmp', :name => 'font', :glyph_folder => '/tmp/glyphs'})
+
+    end
+
+    it 'includes files from assets' do
+      @font.include('header')
+      @font.contents.include?('xml').should eql true
+    end
+
+    it 'deletes existing SVG' do
+      @path = File.expand_path('/tmp/font.svg')
+      system ('touch /tmp/font.svg')
+      File.exists?(@path).should eql true
+      @font.setup()
+      File.exists?(@path).should eql false
+    end
+
+    it 'creates a character sheet' do
+      @font.character_sheet = nil
+      @font.character_sheet.instance_of?(Hieroglyph::CharacterSheet).should eql false
+      @font.setup()
+      @font.character_sheet.instance_of?(Hieroglyph::CharacterSheet).should eql true
+    end
+
+    it 'replaces name token in contents' do
+      @font.contents = 'xxx{{NAME}}xxx'
+      @font.contents = 'xxx{{NAME}}xxx'
+      @font.options[:name] = 'foo'
+      @font.set_name
+      @font.contents.should eql 'xxxfooxxx'
+    end
+
+    it 'writes a file' do
+      @path = '/tmp/font.svg'
+      system("rm #{@path}")
+      File.exists?(@path).should eql false
+      @font.output_path = @path
+      @font.finish
+      File.exists?(@path).should eql true
+      File.delete(@path)
+    end
+
+    it 'adds to contents' do
+      @font.contents = 'foo'
+      @font.add('bar')
+      @font.contents.should eql 'foobar'
+    end
+
+    it 'adds glyphs' do
+      @font.character_sheet.should_receive(:add)
+      @font.add_glyphs
+    end
+
+  end
+end