jitterbug 0.5.1 → 0.6.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Chris Sessions
+Copyright (c) 2010 Flying Saucer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -40,17 +40,17 @@ Pass the `jitterbug` helper a string to convert into a header graphic. Optionall
 
 Install the gem:
 
-    sudo gem install jitterbug
+    gem install jitterbug
 
 Drop any fonts into your project's font directory (by default `/lib/fonts`).
 
-### Rails:
+### Rails 2:
 
 In your `config/environment.rb` file:
 
     Rails::Initializer.run do |config|
       ...
-      config.gem "jitterbug", :source  => 'http://gemcutter.org/'
+      config.gem "jitterbug"
       ...
     end
 
@@ -64,8 +64,6 @@ In your `app\controllers\application_controller.rb` file:
 
 ### Sinatra:
 
-Thanks to [audionerd](http://github.com/audionerd) for making Jitterbug work with Sinatra.
-
     require 'sinatra'
     require 'jitterbug'
     
@@ -80,10 +78,6 @@ Thanks to [audionerd](http://github.com/audionerd) for making Jitterbug work wit
 
 `Jitterbug::Config.env` is the a string representing the current environment (e.g.: `"development"` or `"production"`).
 
-### Merb, Ramaze, others...
-
-Any takers?
-
 ## Available Options
 
 `:background` Background color for the generated header image (default `transparent`)
@@ -102,8 +96,6 @@ Any takers?
 
 `:img_path` Image path for generated header images (default `/content/jitterbug/`)
 
-`:kerning` Kerning value to apply to the generated header's text (default `0`)
-
 `:size` Font size for the generated header image (default `16`)
 
 `:style` Any additional inline styles to include in the generated tag
@@ -143,23 +135,27 @@ And relies on an external stylesheet like the following:
 
 ## Global Configuration
 
-You can optionally define a global configuration in `config/jitterbug.yml`. The following sample contains Jitterbug's built in defaults. Note that the asterisk default for the font causes Jitterbug to use the first font that it finds in the font_dir folder.
-
-    development:   &defaults
-      background:  transparent
-      color:       black
-      font:        *
-      font_dir:    /lib/fonts/
-      format:      png
-      img_path:    /content/jitterbug/
-      size:        24
-
-    test:
-      <<:          *defaults
-      img_path:    /tmp/jitterbug/
-
-    production:
-      <<:          *defaults
+You can optionally define a global configuration in `config/jitterbug.yml`. The following sample mirrors Jitterbug's built in defaults. Note that the asterisk default for the font causes Jitterbug to use the first font that it finds in the font_dir folder.
+
+Jitterbug 0.6.0 uses a new configuration format, breaking compatibility with older versions. The initial root-level block defines the default values. You can include tag-specific cascading definitions. In the config below, `H1` tags are 24pt black text, `H2` tags are 16pt black text in the DinMedium font, and `H2` tags with class `small` specified are 8pt red text in the DinMedium font.
+
+    # Defaults
+    background: transparent
+    color:      '#000000'
+    font:       *
+    font_dir:   /lib/fonts/
+    format:     png
+    img_path:   /content/jitterbug/
+    size:       24
+
+    # Tag-Specific
+    h2:
+      font:     DinMedium
+      size:     16
+                
+    h2.small:
+      color:    red
+      size:     8
       
 ## Dependencies
 
@@ -170,3 +166,16 @@ Jitterbug uses [Imagemagick](http://www.imagemagick.org/script/index.php) to bui
 Jitterbug has been tested on OSX and Linux.
 
 The following font formats have successfully passed through the Jitterbug: OpenType (PostScript flavored), OpenType (TrueType flavored), PostScript (Type1), TrueType (Mac), and TrueType (PC). When processing Postscript fonts, Jitterbug (or rather Imagemagick) only uses the font outline file. Note that you should remove any spaces from your font filenames.
+
+If you're using older Mac PostScript fonts you'll need to copy the font definitions from the resource fork to the data fork (see [here](http://wiki.github.com/sorccu/cufon/trouble-with-font-files) for more information). In OSX you'd do this:
+
+    cat "FontName/..namedfork/rsrc" > "FontName.dfont"
+
+## Contributors
+
+Many thanks to the following contributors:
+
+* Sinatra compatibility by [audionerd](http://github.com/audionerd)
+* Apostrophe fix by [Neal White](http://www.cohesivecc.com/)
+
+Jitterbug is written and maintained by [Flying Saucer](http://flying-saucer.net/)

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/jitterbug.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jitterbug}
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Sessions", "Seth Engelhard"]
-  s.date = %q{2009-11-17}
+  s.date = %q{2010-02-26}
   s.description = %q{Jitterbug provides on-demand text header images using the font of your choice. On its first request, Jitterbug creates the requested header graphic. Then, and on subsequent requests, it returns an html image tag pointing to the header graphic file.}
   s.email = %q{contact@flying-saucer.net}
   s.extra_rdoc_files = [
@@ -25,10 +25,6 @@ Gem::Specification.new do |s|
      "VERSION",
      "jitterbug.gemspec",
      "lib/jitterbug.rb",
-     "lib/jitterbug/config.rb",
-     "lib/jitterbug/css.rb",
-     "lib/jitterbug/fonts.rb",
-     "lib/jitterbug/html.rb",
      "spec/jitterbug_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"

data/lib/jitterbug.rb

@@ -1,36 +1,121 @@
 require 'md5'
-%w(config css fonts html).each do |conf|
-  require File.expand_path(File.join(File.dirname(__FILE__), 'jitterbug', conf))
-end
 
 module Jitterbug
   
   def self.included(base)
-    Jitterbug::Config.read
+    Config.read_yaml
   end
 
   def jitterbug(label = '<jitterbug>', options = {})
-    options = Jitterbug::Config.settings.merge(options)
-    root = Jitterbug::Config.root
-    hash = MD5.new("#{label}#{options.sort {|a, b| a[0].to_s <=> b[0].to_s}.to_s}")
-    path = "#{root}/public/#{options[:img_path]}/#{hash}.#{options[:format]}".gsub('//', '/')
-    unless File.exist?(path)
-      caption = options[:width] ? "-size #{options[:width]}x caption:'#{label}'" : "label:'#{label}'"
-      FileUtils.mkdir_p("#{root}/public/#{options[:img_path]}".gsub('//', '/'))
-      `convert -background #{options[:background]} -fill "#{options[:color]}" \
-        -font #{Jitterbug::Fonts.find(options[:font_dir], options[:font])} \
-        -pointsize #{options[:size]} -blur 0x.3 #{caption} #{path}`
-      # -kerning #{options[:kerning]} TODO add leading and kerning
-    end
-    img_src   = "/#{options[:img_path]}/#{hash}.#{options[:format]}".gsub('//', '/')
-    img_class = (['jitterbug'] << options[:class]).compact.join(' ')
-        
-    if options[:tag]
-      Jitterbug::Html.tag(options[:tag], label, :class => img_class, :style => Jitterbug::Css.tag(img_src, options))
-    elsif options[:fat]
-      Jitterbug::Html.tag(options[:fat], label, :class => img_class, :style => Jitterbug::Css.fat(img_src, options))
-    else
-      Jitterbug::Html.img(img_src, :alt => label, :class => img_class, :style => options[:style])
+    opts  = Config.settings(options)
+    image = Make.header(label, opts)
+    Html.render(image, label, opts)
+  end
+
+  module Config
+
+    @@settings = { :background => 'transparent',
+                   :color      => 'black',
+                   :font       => '*',
+                   :font_dir   => '/lib/fonts/',
+                   :format     => 'png',
+                   :img_path   => '/content/jitterbug/',
+                   :size       => 24,
+                   :root       => RAILS_ROOT,
+                   :env        => RAILS_ENV }
+
+    # TODO add :leading setting which requires >ImageMagick 6.5.5-8 to use -interline-spacing option
+    # TODO add :kerning setting
+
+    def self.read_yaml
+      config = File.join(@@settings[:root], 'config', 'jitterbug.yml')
+      if File.exist?(config)
+        YAML.load_file(config).each {|key, value| @@settings[key.to_sym] = value}
+      end
+    end
+    
+    def self.settings(opts)
+      @@settings.merge(smash(opts[:tag])).
+                 merge(smash("#{opts[:tag]}.#{opts[:class]}".to_sym)).
+                 merge(opts)
+    end
+
+    def self.smash(sub)
+      if @@settings[sub].nil?
+        {}
+      else
+        @@settings[sub].inject({}) do |opts, (key, value)|
+          opts[(key.to_sym rescue key) || key] = value
+          opts
+        end
+      end
+    end
+
+    def self.root=(val)
+      @@settings[:root] = val
+    end
+    
+    def self.env=(val)
+      @@settings[:env] = val
+    end
+  end
+
+  module Html
+
+    def self.render(img_src, label, opts = {})
+      img_class = (['jitterbug'] << opts[:class]).compact.join(' ')
+      if opts[:tag]
+        tag(opts[:tag], label, :class => img_class, :style => skinny_styles(img_src, opts))
+      elsif opts[:fat]
+        tag(opts[:fat], label, :class => img_class, :style => fat_styles(img_src, opts))
+      else
+        tag(:img, nil, :src => img_src, :alt => label, :class => img_class, :style => opts[:style])
+      end
+    end
+
+    def self.tag(type, content, opts)
+      attrs = opts.collect { |key, val| val.blank? ? nil : "#{key}=\"#{val}\"" }.compact.join(' ')
+      base  = (attrs.present? ? "<#{type} #{attrs}" : "<#{type}")
+      base << (content ? ">#{content}</#{type}>" : " />")
+    end
+    
+    def self.fat_styles(src, opts)
+      css = "display:block;text-indent:-9999px;margin:0;padding:0;background:url(#{src})no-repeat;"
+      css += "height:#{opts[:size]}px;" if opts[:width].nil?
+      "#{css}#{opts[:style].to_s}"
+    end
+
+    def self.skinny_styles(src, opts)
+      "background-image:url(#{src});#{opts[:style].to_s}"
+    end
+  end
+
+  module Make
+
+    def self.header(label, opts)
+      hash  = MD5.new("#{label}#{opts.sort {|a, b| a[0].to_s <=> b[0].to_s}.to_s}")
+      image = "/#{opts[:img_path]}/#{hash}.#{opts[:format]}".gsub('//', '/')
+      path  = "#{opts[:root]}/public/#{image}".gsub('//', '/')
+
+      if !File.exist?(path)
+        label.gsub!(/'/, "'\\\\\''")
+        caption = opts[:width] ? "-size #{opts[:width]}x caption:'#{label}'" : "label:'#{label}'"
+        FileUtils.mkdir_p("#{opts[:root]}/public/#{opts[:img_path]}".gsub('//', '/'))
+        `convert -background #{opts[:background]} -fill "#{opts[:color]}" \
+          -font #{find_font(opts)} -pointsize #{opts[:size]} -blur 0x.3 \
+          #{caption} #{path}`
+      end
+      image
+    end
+    
+    def self.find_font(opts)
+      path = "#{opts[:root]}/#{opts[:font_dir]}/*#{opts[:font]}*".gsub('//', '/')
+      font = Dir.glob(path)
+      case font.size
+        when 0: raise "*** Jitterbug Error: Font '#{opts[:font]}' could not be found in #{opts[:font_dir]}"
+        when 1: return font.first
+        else    raise "*** Jitterbug Error: Multiple fonts matched '#{opts[:font]}' in #{opts[:font_dir]}:\n    + #{font.join("\n    + ")}"
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jitterbug
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Chris Sessions
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-17 00:00:00 -08:00
+date: 2010-02-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,10 +41,6 @@ files:
 - VERSION
 - jitterbug.gemspec
 - lib/jitterbug.rb
-- lib/jitterbug/config.rb
-- lib/jitterbug/css.rb
-- lib/jitterbug/fonts.rb
-- lib/jitterbug/html.rb
 - spec/jitterbug_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb

data/lib/jitterbug/config.rb

@@ -1,43 +0,0 @@
-module Jitterbug
-  module Config
-
-    @@settings = { :background => 'transparent',
-                   :color      => 'black',
-                   :font       => '*',
-                   :font_dir   => '/lib/fonts/',
-                   :format     => 'png',
-                   :kerning    => 0,
-                   :img_path   => '/content/jitterbug/',
-                   :size       => 24 }
-
-    def self.read      
-      # TODO add :leading setting which requires >ImageMagick 6.5.5-8 to use -interline-spacing option
-      config = "#{Jitterbug::Config.root}/config/jitterbug.yml"
-      if File.exist?(config)
-        YAML.load_file(config)[Jitterbug::Config.env].each {|key, value| @@settings[key.to_sym] = value}
-      end
-    end
-    
-    def self.settings
-      @@settings
-    end
-    
-    # accessor methods, with defaults for Rails
-    def self.root
-      @@root ||= RAILS_ROOT
-    end
-    
-    def self.root=(value)
-      @@root = value
-    end
-    
-    def self.env
-      @@environment ||= RAILS_ENV
-    end
-    
-    def self.env=(value)
-      @@environment = value
-    end
-
-  end
-end

data/lib/jitterbug/css.rb

@@ -1,15 +0,0 @@
-module Jitterbug
-  module Css
-
-    def self.fat(src, opts)
-      css = "display:block;text-indent:-9999px;margin:0;padding:0;background:url(#{src})no-repeat;"
-      css += "height:#{opts[:size]}px;" if opts[:width].nil?
-      "#{css}#{opts[:style].to_s}"
-    end
-
-    def self.tag(src, opts)
-      "background-image:url(#{src});#{opts[:style].to_s}"
-    end
-
-  end
-end

data/lib/jitterbug/fonts.rb

@@ -1,15 +0,0 @@
-module Jitterbug
-  module Fonts
-    
-    def self.find(_path, _font)
-      path = "#{Jitterbug::Config.root}/#{_path}/*#{_font}*".gsub('//', '/')
-      font = Dir.glob(path)
-      case font.size
-        when 0: raise "*** Jitterbug Error: Font '#{_font}' could not be found in #{_path}"
-        when 1: return font.first
-        else    raise "*** Jitterbug Error: Multiple fonts matched '#{_font}' in #{_path}:\n    + #{font.join("\n    + ")}"
-      end
-    end
-
-  end
-end

data/lib/jitterbug/html.rb

@@ -1,15 +0,0 @@
-module Jitterbug
-  module Html
-
-    def self.img(src, opts = {})
-      tag(:img, nil, opts.merge(:src => src))
-    end
-
-    def self.tag(type, content, opts = {})
-      attrs = opts.collect { |key, val| val.blank? ? nil : "#{key}=\"#{val}\"" }.compact.join(' ')
-      base  = (attrs.present? ? "<#{type} #{attrs}" : "<#{type}")
-      base << (content ? ">#{content}</#{type}>" : " />")
-    end
-
-  end
-end