jitterbug 0.4.0 → 0.5.0

data/README.markdown

@@ -1,6 +1,8 @@
 # Jitterbug: A just-in-time image creator for pretty text headers
 
-Jitterbug provides on-demand graphical text headers using the font of your choice. On the first request, Jitterbug creates the requested header graphic and returns its image tag. On subsequent requests it returns the image tag of the already-created graphic.
+[Jitterbug](http://github.com/flyingsaucer/jitterbug) is a gem that provides on-demand graphical text headers using the font of your choice. Use wherever large collections of rich text headers are necessary — especially useful in i18n projects.
+
+On the initial request, Jitterbug creates the specified header graphic and returns its image or header tag. On subsequent requests it references the already-created graphic and returns the requested valid xhtml tag.
 
 ## Usage
 
@@ -40,6 +42,10 @@ Install the gem:
 
     sudo gem install jitterbug
 
+Drop any fonts into your project's font directory (by default `/lib/fonts`).
+
+### Rails:
+
 In your `config/environment.rb` file:
 
     Rails::Initializer.run do |config|
@@ -56,8 +62,28 @@ In your `app\controllers\application_controller.rb` file:
       ...
     end
 
-Drop any fonts into your project's font directory (by default `/lib/fonts`).
+### Sinatra:
+
+Thanks to [audionerd](http://github.com/audionerd) for making Jitterbug work with Sinatra.
+
+    require 'sinatra'
+    require 'jitterbug'
     
+    Jitterbug::Config.root = File.dirname(__FILE__)
+    Jitterbug::Config.env  = Sinatra::Application::environment.to_s
+
+    helpers do
+      include Jitterbug
+    end
+    
+`Jitterbug::Config.root` is the root path, which should include folders like `public/`, `lib/` and `config/`.
+
+`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`)
@@ -76,6 +102,8 @@ Drop any fonts into your project's font directory (by default `/lib/fonts`).
 
 `: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
@@ -113,26 +141,9 @@ And relies on an external stylesheet like the following:
       text-indent: -9999px;
     }
 
-## Dependencies
-
-Jitterbug uses `Imagemagick` to build the header images. It needs to be installed on your development and production machines, as do any fonts that you're using. The default location for fonts is `/lib/fonts` in your project.
-
-Jitterbug's currently Rails-centric, with these Rails dependencies: `RAILS_ROOT`, `content_tag`, `image_tag`. These aren't completely necessary, but we haven't had a need to remove them yet.
-
-## Compatibility and Font Types
-
-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. Please rename any fonts with spaces in their filename.
-
-## Quick Links
-
- * [github.com/flyingsaucer/jitterbug](http://github.com/flyingsaucer/jitterbug)
- * [imagemagick.org](http://www.imagemagick.org/script/index.php)
-
 ## Global Configuration
 
-Define your 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.
+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
@@ -141,11 +152,21 @@ Define your global configuration in `config/jitterbug.yml`. The following sample
       font_dir:    /lib/fonts/
       format:      png
       img_path:    /content/jitterbug/
-      size:        16
+      size:        24
 
     test:
       <<:          *defaults
       img_path:    /tmp/jitterbug/
 
     production:
-      <<:          *defaults
+      <<:          *defaults
+      
+## Dependencies
+
+Jitterbug uses [Imagemagick](http://www.imagemagick.org/script/index.php) to build the header images. It needs to be installed on your development and production machines, as do any fonts that you're using. The default location for fonts is `/lib/fonts` in your project.
+
+## Compatibility and Font Types
+
+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.

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/jitterbug.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jitterbug}
-  s.version = "0.4.0"
+  s.version = "0.5.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-12}
+  s.date = %q{2009-11-17}
   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 = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "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,18 +1,20 @@
 module Jitterbug
   module Config
-    
+
     @@settings = { :background => 'transparent',
                    :color      => 'black',
                    :font       => '*',
                    :font_dir   => '/lib/fonts/',
                    :format     => 'png',
+                   :kerning    => 0,
                    :img_path   => '/content/jitterbug/',
-                   :size       => 16 }
+                   :size       => 24 }
 
-    def self.read
-      config = "#{RAILS_ROOT}/config/jitterbug.yml"
+    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)[RAILS_ENV].each {|key, value| @@settings[key.to_sym] = value}
+        YAML.load_file(config)[Jitterbug::Config.env].each {|key, value| @@settings[key.to_sym] = value}
       end
     end
     
@@ -20,5 +22,22 @@ module Jitterbug
       @@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/fonts.rb

@@ -2,7 +2,7 @@ module Jitterbug
   module Fonts
     
     def self.find(_path, _font)
-      path = "#{RAILS_ROOT}/#{_path}/*#{_font}*".gsub('//', '/')
+      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}"

data/lib/jitterbug/html.rb

@@ -0,0 +1,15 @@
+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

data/lib/jitterbug.rb

@@ -1,7 +1,7 @@
-require 'jitterbug/config'
-require 'jitterbug/css'
-require 'jitterbug/fonts'
 require 'md5'
+%w(config css fonts html).each do |conf|
+  require File.expand_path(File.join(File.dirname(__FILE__), 'jitterbug', conf))
+end
 
 module Jitterbug
   
@@ -11,23 +11,26 @@ module Jitterbug
 
   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 = "#{RAILS_ROOT}/public/#{options[:img_path]}/#{hash}.#{options[:format]}".gsub('//', '/')
+    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}'"
-      `mkdir -p #{"#{RAILS_ROOT}/public/#{options[:img_path]}".gsub('//', '/')}`
+      `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]} -pointsize #{options[:size]} -blur 0x.3 \
+        #{caption} #{path}`
     end
     img_src   = "/#{options[:img_path]}/#{hash}.#{options[:format]}".gsub('//', '/')
     img_class = (['jitterbug'] << options[:class]).compact.join(' ')
+        
     if options[:tag]
-      content_tag(options[:tag], label, :class => img_class, :style => Jitterbug::Css.tag(img_src, options))
+      Jitterbug::Html.tag(options[:tag], label, :class => img_class, :style => Jitterbug::Css.tag(img_src, options))
     elsif options[:fat]
-      content_tag(options[:fat], label, :class => img_class, :style => Jitterbug::Css.fat(img_src, options))
+      Jitterbug::Html.tag(options[:fat], label, :class => img_class, :style => Jitterbug::Css.fat(img_src, options))
     else
-      image_tag(img_src, :alt => label, :class => img_class)
+      Jitterbug::Html.img(img_src, :alt => label, :class => img_class, :style => options[:style])
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jitterbug
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Chris Sessions
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-12 00:00:00 -08:00
+date: 2009-11-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,7 @@ files:
 - 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