hieroglyph 0.1 → 0.1.1

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -1,8 +1,11 @@
 # Hieroglyph
 
-Convert a folder full of icons into an SVG icon font, ready for use on the web. 
-To produce the remaining web filetypes (eot, ttf, woff) run the gem through [Fontsquirrel generator](http://www.fontsquirrel.com/fontface/generator).
-If rmagick is installed (optional), hieroglyph will also create a neat little character sheet.
+Icon fonts are a great way to put sharp, highly-malleable icons onto your website using @font-face. [Chris Coyier thinks they're a good idea](http://css-tricks.com/using-fonts-for-icons/), and you should too.
+
+Hieroglyph lets you turn a directory of SVG icons into an SVG font, all simple-like.
+To produce the remaining web filetypes (eot, ttf, woff) run the font file through [Fontsquirrel's generator](http://www.fontsquirrel.com/fontface/generator).
+
+If rmagick is installed (optional), hieroglyph will also draw a character sheet PNG for you.
 
 ## Installation
 
@@ -40,13 +43,14 @@ Using the -e or -v arguments will NOT output a font.
 
 ## Thanks
 
-- [Chris Coyier](http://chriscoyier.net/), for brining attention to the [icon fonts.](http://css-tricks.com/using-fonts-for-icons/)
+- [Chris Coyier](http://chriscoyier.net/), for bringing attention to the [icon font technique.](http://css-tricks.com/using-fonts-for-icons/)
 - [Stephen Wyatt Bush](http://stephenwyattbush.com/), for his in-depth [tutorial.](http://blog.stephenwyattbush.com/2012/02/01/making-an-icon-font)
 - [Jeremy Holland](http://www.jeremypholland.com/), for the [Savage SVG parsing gem.](https://github.com/awebneck/savage)
 - [Inkscape contributors](https://launchpad.net/inkscape/+topcontributors), who provided the original SVG font tool I used a lot on this project.
 
 ## Todo
 
+- Tests
 - Clean up Glyph class. It's crazy!
 - Parse from EPS _or_ SVG. Not sure if this is doable with available open-source technology.
 - Use private use unicode symbols, for accessibility reasons:

data/hieroglyph.gemspec

@@ -9,11 +9,17 @@ Gem::Specification.new do |gem|
   gem.homepage      = "http://github.com/averyvery/hieroglyph"
 
   gem.files         = `git ls-files`.split($\)
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "hieroglyph"
   gem.require_paths = ["lib"]
   gem.version       = Hieroglyph::VERSION
+
 	gem.add_dependency("nokogiri", ">= 0")
   gem.add_dependency("savage", ">= 0")
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "bourne"
+  gem.add_development_dependency "rmagick"
 end

data/lib/hieroglyph.rb

@@ -1,10 +1,13 @@
-require 'hieroglyph/glyph'
-require 'hieroglyph/font'
-require 'hieroglyph/character_sheet'
+RMAGICK_INSTALLED = begin
+  require 'rmagick'
+  true
+rescue Gem::LoadError
+  false
+end
 
 module Hieroglyph
 
-  VERSION = "0.1"
+  VERSION = "0.1.1"
 
   def self.log(*args)
     args.each do |arg|
@@ -17,9 +20,10 @@ module Hieroglyph
   end
 
   def self.rmagick_installed?
-    Gem::Specification.find_by_name("rmagick")
-  rescue Gem::LoadError
-    false
+    ::RMAGICK_INSTALLED
   end
-
 end
+
+require 'hieroglyph/glyph'
+require 'hieroglyph/font'
+require 'hieroglyph/character_sheet'

data/lib/hieroglyph/character_sheet.rb

@@ -1,10 +1,9 @@
 module Hieroglyph
 
-  class CharacterSheet
+  if rmagick_installed?
+    class CharacterSheet
 
-    def initialize(options)
-      if Hieroglyph.rmagick_installed?
-        require 'rmagick'
+      def initialize(options)
         @options = options
         @output_path = File.join(@options[:output_folder], @options[:name]) + "_characters.png"
         if File.exist? @output_path
@@ -12,21 +11,15 @@ module Hieroglyph
           File.delete @output_path
         end
         @characters = Magick::ImageList.new
-      else
-        Hieroglyph.log "  ImageMagick not installed, skipping character sheet"
       end
-    end
 
-    def add(file, name)
-      if Hieroglyph.rmagick_installed?
+      def add(file, name)
         character = Magick::Image::read(file).first
         character['Label'] = name
         @characters.push character
-      end
-    end 
+      end 
 
-    def save
-      if Hieroglyph.rmagick_installed?
+      def save
         name = @options[:name]
         img = @characters.montage do
           self.background_color = "#ffffff"
@@ -41,6 +34,16 @@ module Hieroglyph
       end
     end
 
+  else
+    # No-op
+    class CharacterSheet
+      def initialize(*)
+      end
+      def add(file, name)
+      end
+      def save
+      end
+    end
   end
 
 end

data/lib/hieroglyph/version.rb

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

data/spec/lib/hieroglyph/character_sheet_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Hieroglyph::CharacterSheet do
+  context "A CharacterSheet" do
+    before :each do
+      @characters = stub(:push)
+      Magick::ImageList.stubs(:new).returns(@characters)
+
+      @character_sheet = Hieroglyph::CharacterSheet.new({:output_folder => '/tmp', :name => 'sheet'})
+    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')
+
+      Magick::Image.should have_received(:read).with('a file')
+      character.should have_received(:[]=).with('Label', 'some name')
+      @characters.should have_received(:push).with(character)
+    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.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')
+    end
+  end
+end

data/spec/lib/hieroglyph/font_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Hieroglyph::Font do
+  
+end

data/spec/lib/hieroglyph/glyph_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Hieroglyph::Glyph do
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'bundler'
+Bundler.setup(:test)
+
+require 'rspec'
+require 'mocha'
+require 'bourne'
+
+require File.expand_path('../../lib/hieroglyph', __FILE__)
+
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # config.treat_symbols_as_metadata_keys_with_true_values = true
+  # config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+  config.mock_with :mocha
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hieroglyph
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-19 00:00:00.000000000Z
+date: 2012-03-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70103367137480 !ruby/object:Gem::Requirement
+  requirement: &70178521601540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70103367137480
+  version_requirements: *70178521601540
 - !ruby/object:Gem::Dependency
   name: savage
-  requirement: &70103367136980 !ruby/object:Gem::Requirement
+  requirement: &70178521601040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,51 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70103367136980
+  version_requirements: *70178521601040
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70178521600660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70178521600660
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70178521600200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70178521600200
+- !ruby/object:Gem::Dependency
+  name: bourne
+  requirement: &70178521599780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70178521599780
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: &70178521599360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70178521599360
 description: Generate a web-ready SVG font from a directory of SVG icons
 email:
 - dougunderscorenelson@gmail.com
@@ -42,6 +86,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
@@ -60,6 +105,10 @@ files:
 - lib/hieroglyph/font.rb
 - lib/hieroglyph/glyph.rb
 - lib/hieroglyph/version.rb
+- spec/lib/hieroglyph/character_sheet_spec.rb
+- spec/lib/hieroglyph/font_spec.rb
+- spec/lib/hieroglyph/glyph_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/averyvery/hieroglyph
 licenses: []
 post_install_message: 
@@ -84,4 +133,8 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Icon font creator
-test_files: []
+test_files:
+- spec/lib/hieroglyph/character_sheet_spec.rb
+- spec/lib/hieroglyph/font_spec.rb
+- spec/lib/hieroglyph/glyph_spec.rb
+- spec/spec_helper.rb