magick_title 0.1.0 → 0.1.2

data/README.md

@@ -1,26 +1,67 @@
 Magick Title
 ============
 
-Want beautiful browser-compatible custom-smoothed & kerned fonts? Magick Title delivers just that by using imagemagick to generate titles based on the options you provide.
+Want beautiful copyright-protected browser-compatible custom-smoothed & kerned fonts? MagickTitle delivers just that by using imagemagick to generate titles based on the options you provide.
 
-** ----- under construction! ----- **
+** ----- under construction, but getting closer! ----- **
    
+
 Usage
 -----
 
-Using MagickTitle is easy:
+Using MagickTitle is easy. First, customize your global title styles by setting MagickTitle's default options while loading your app. If your using rails, it's best to do this in `config/initializers/magick_title.rb`. 
+
+    # Here's the defaults
+    MagickTitle.options = {
+      :root => "./",
+      :font => "PermanentMarker.otf",
+      :font_path => Proc.new{ File.join MagickTitle.root, "fonts" },
+      :font_size => 50,
+      :destination => Proc.new{ File.join MagickTitle.root, "public/system/titles" },
+      :extension => "png",
+      :width => 800,
+      :height => nil,
+      :background_color => '#ffffff',
+      :background_alpha => '00',
+      :color => '#68962c',
+      :weight => 400,
+      :kerning => 0,
+      :command_path => nil,
+      :log_command => false,
+      :cache => true,
+      :to_html => {
+        :parent => {
+          :tag   => "h1",
+          :class => "image-title"
+        },
+        :class => "magick-title"
+      }
+    }
+    
+Set as few or as many options as you'd like. Your custom options will get merged into the defaults... You can also set individual options like this:
+
+    MagickTitle.options[:font] = 'Lobster.ttf'
+    
+      
+Once you've set your options to your liking, just create a title like so:
 
     MagickTitle.say("Hello!").to_html 
     
-    # outputs
-    # <h1><img src="/system/titles/hello.png" alt="Bienvenida al mundo de 28 Buenos Días " class="magick-title"></h1>
+    #=> <h1 class="image-title"><img class="magick-title" alt="Hello!" src="/system/titles/hello_8e05f22657a3573d8fc6fa8115fecfc0812d82be.png"/></h1>
+
+
+Place the image title in a div rather than an h1:
+
+    MagickTitle.say("Hello!").to_html("div")
+    
+    #=> <div><img class="magick-title" alt="Hello!" src="/system/titles/hello_f76179c852bb2fa264b8ad2c0c9ceeb9f99dfc0b.png"/></div>
 
-Without the h1 tag: 
+
+Or without the h1 tag: 
   
     MagickTitle.say("Hello!").to_html(false)
     
-    # outputs
-    # <img src="/system/titles/hello.png" alt="Bienvenida al mundo de 28 Buenos Días " class="magick-title">
+    #=> <img class="magick-title" alt="Hello!" src="/system/titles/hello_f76179c852bb2fa264b8ad2c0c9ceeb9f99dfc0b.png"/>
 
 
 To just get an instance of MagickTitle::Image:
@@ -31,15 +72,41 @@ To just get an instance of MagickTitle::Image:
     puts title.url #=> "/system/titles/hello.png"
 
 
-More to come!
+Or set some options on the fly:
+
+    MagickTitle.say("Hello!", :font_size => 24, :color => '#ff0000').to_html
+    
+    #=> <h1 class="image-title"><img class="magick-title" alt="Hello!" src="/system/titles/hello_080fb04470589c55cd0e22c3229d2006baa05f7d.png"/></h1>
+    
+Note how the token is different than the previous 'Hello!' titles since we've set custom options.
+    
+    
+The html helper can also be customized:
+
+    MagickTitle.say("Hello!").to_html(:class => "custom-title", :parent => { :tag => "h3", :id => "maaaagick" })
+    
+    #=> <h3 id="maaaagick"><img class="custom-title" alt="Hello!" src="/system/titles/hello_f76179c852bb2fa264b8ad2c0c9ceeb9f99dfc0b.png"/></h3>
+
+Combine no-parent with custom attributes:
+
+    MagickTitle.say("Hello!").to_html(:class => "custom-title", :parent => nil)
+     
+    #=> <img class="custom-title" alt="Hello!" src="/system/titles/hello_f76179c852bb2fa264b8ad2c0c9ceeb9f99dfc0b.png"/>
+
+
+    
+    
+## More to come!
+
 
    
 To Do
 -----
 
-* Write tests
-* Write documentation
-* Auto ActiveRecord integration (this will be a seperate HasImage gem)
+* Write more tests
+* Smart option validation (:color => 'fff' converts to :color => '#fff' and :color => 'pink' fails)
+* More documentation
+* Auto ActiveRecord integration (`has_magick_title` class method)
 * Clean up and publish demo app
 
 

data/lib/magick_title/image.rb

@@ -1,3 +1,4 @@
+require 'digest/sha1'
 require 'fileutils' unless defined?(FileUtils)
 
 module MagickTitle
@@ -33,7 +34,7 @@ module MagickTitle
       @text = text
       return false unless valid?
       @options = (@options || MagickTitle.options).merge(opts.symbolize_keys)
-      @filename = unique_filename(@text)
+      @filename = filename_from_options #unique_filename(@text)
       @path = options.destination
       @url = File.join((@path.match(/public(\/.*)/) || ['', './'])[1].to_s, @filename)
     end
@@ -44,7 +45,7 @@ module MagickTitle
     def save
       return false unless valid?
       FileUtils.mkdir_p(path)
-      run('convert', title_command_string)
+      run('convert', title_command_string(fullpath))
       File.exists?(fullpath)
     end
     
@@ -61,36 +62,28 @@ module MagickTitle
     end
     
     
-    
+    # Creates and HTML image tag with the options provided
     def to_html(opts={})
       opts = { :parent => nil } if opts === false
-      opts = { 
-        :parent => {
-          :tag   => "h1",
-          :class => "image-title"
-        },
-        :class => "magick-title",
-        :alt => text,
-        :src => url
-      }.merge(opts)
+      opts = { :parent => opts } if opts.is_a?(String)
+      opts = MagickTitle.options[:to_html].merge(:alt => text, :src => url).merge(opts)
       parent = opts.delete(:parent)
-      parent = { :tag => parent } if parent.is_a?(String)
-      tag = %(<img #{hash_to_attributes(opts)}/>)
+      tag = %(<img#{hash_to_attributes(opts)}/>)
       if parent
-        ptag = parent.delete(:tag)
-        tag = %(<#{ptag} #{hash_to_attributes(parent)}>#{tag}</#{ptag}>)
-      end      
+        ptag = parent.is_a?(String) ? parent : parent.is_a?(Hash) ? parent.delete(:tag) : nil
+        ptag ||= "h1"
+        tag = %(<#{ptag}#{hash_to_attributes(parent)}>#{tag}</#{ptag}>)
+      end    
       tag
     end
     
+    
+    # Converts a hash to a string of html style key="value" pairs
     def hash_to_attributes(hash)
-      attributes = ""
-      hash.each { |key, value| attributes << key.to_s << "=\"" << value << "\" " if value and 0 < value.length }
-      
-      puts "* 88"
-      puts attributes.inspect
-      
-      attributes
+      attributes = []
+      return "" unless hash.is_a?(Hash)
+      hash.each { |key, value| attributes << %(#{key}="#{value}") if value and 0 < value.length }
+      " " + attributes.join(" ").strip
     end
     
     
@@ -103,7 +96,7 @@ module MagickTitle
       end
       
       # builds an imagemagick command based on the supplied options 
-      def title_command_string
+      def title_command_string(file="")
         %(
           -trim
           -antialias
@@ -115,10 +108,11 @@ module MagickTitle
           -weight #{options.weight}
           -kerning #{options.kerning}
           caption:'#{@text}'
-          #{fullpath}
+          #{file}
         ).gsub(/[\n\r\s]+/, ' ')
       end 
       
+      
       # Cleans and runs the supplied command       
       # (stolen from paperclip)
       def run(cmd, params)
@@ -127,27 +121,33 @@ module MagickTitle
         `#{command}`
       end 
       
+      
       # returns the `bin` path to the command
       def path_for_command(command)
         path = [options.command_path, command].compact
         File.join(*path)
       end
       
-      # converts the text to a useable filename
-      # defaults to a random string if the filename is blank after replacing illegal chars
+      
+      # Creates a filename token based on the title's options
+      def filename_from_options
+        digest = Digest::SHA1.hexdigest(title_command_string)
+        "#{unique_filename}_#{digest}.#{options.extension}"
+      end
+      
+      
+      # Truncates if necessary and converts the text to a useable filename
       def fileize_text(text)
+        text = text[0..31] if 32 < text.length
         file = text.to_s.downcase.gsub(/[^a-z0-9\s\-\_]/, '').strip.gsub(/[\s\-\_]+/, '_')
-        unless 0 < file.length
-          o =  [('a'..'z'),('0'..'9')].map{|i| i.to_a}.flatten
-          file = (0..31).map{ o[rand(o.length)]  }.join
-        end
         file
       end
       
       
-      # creates a unique filename for the supplied text
-      def unique_filename(text)
-        file = fileize_text(text)
+      
+      # creates a unique filename for the title's text
+      def unique_filename
+        file = fileize_text(@text)
         exists = exists_in_destination? file
         dupe, count = nil, 0
         while exists do
@@ -155,12 +155,13 @@ module MagickTitle
           dupe = "#{file}_#{count}"
           exists = exists_in_destination? dupe
         end
-        "#{dupe || file}.#{options.extension}"
+        dupe || file
       end
       
+      
       # Checks if file exists in the destination option
       def exists_in_destination?(file)
-        file += options.extension unless file.match(/\.[a-z]{3,4}$/)
+        file = [file, options.extension].join(".") unless file.match(/\.[a-z]{3,4}$/)
         File.exists?(File.join(options.destination, file))
       end
           

data/lib/magick_title/options.rb

@@ -2,12 +2,14 @@ module MagickTitle
 
   class Options < Hash
   
+  
     # Initializes the options hash with the defaults
     def initialize
       super
       default!
     end
     
+    
     # Clears current options and resets to the defaults
     def default!
       clear
@@ -15,17 +17,18 @@ module MagickTitle
       merge! defaults
     end
 
+
     # A shortcut to [:root]
     def root
       @root ||= fetch(:root)
     end
     
+    
     # The default options hash
     def defaults
       {
         :root => "./",
-        :field_name => 'title',
-        :font => "HelveticaNeueLTStd-UltLt.otf",
+        :font => "PermanentMarker.ttf",
         :font_path => Proc.new{ File.join MagickTitle.root, "fonts" },
         :font_size => 50,
         :destination => Proc.new{ File.join MagickTitle.root, "public/system/titles" },
@@ -39,10 +42,18 @@ module MagickTitle
         :kerning => 0,
         :command_path => nil,
         :log_command => false,
-        :cache => true
+        :cache => true,
+        :to_html => {
+          :parent => {
+            :tag   => "h1",
+            :class => "image-title"
+          },
+          :class => "magick-title"
+        }
       }
     end
     
+    
     # Sets and option and converts its key to a symbol
     def []=(key, value)
       key = key.to_sym
@@ -50,14 +61,18 @@ module MagickTitle
       super(key, value)
     end
     
+    
     # Turns the key into a symbol and returns the requested value
     def [](key)
       val = fetch key.to_sym
       val.is_a?(Proc) ? val.call : val
     end
-            
-    # Retrieve a saved setting or return nil if it doesn't exist.
-    #
+    
+    
+    # Retrieve a saved setting by dynamically looking up its value in the hash.
+    # Call the value if it's a Proc and return nil if the key's value doesn't exist.
+    #   
+    #   Options[:foo] = "bar"
     #   Options.foo #=> "bar"
     #   Options.fuz #=> method missing error
     #

data/lib/magick_title/version.rb

@@ -1,3 +1,3 @@
 module MagickTitle
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/test/bench/hash_to_attributes.rb

@@ -0,0 +1,34 @@
+require 'benchmark'
+
+puts "Benchmark Hash to Attribtes"
+puts " string vs array"
+puts "-" * 50
+
+# Converts a hash to a string of html style key="value" pairs
+def hash_to_attributes_using_string(hash)
+  attributes = ""
+  return attributes unless hash.is_a?(Hash)
+  hash.each { |key, value| attributes << key.to_s << "=\"" << value.strip << "\" " if value and 0 < value.length }
+  attributes.strip
+end
+
+def hash_to_attributes_using_array(hash)
+  attributes = []
+  return attributes unless hash.is_a?(Hash)
+  hash.each { |key, value| attributes << %(#{key}="#{value.strip}") if value and 0 < value.length }
+  attributes.join(" ")
+end
+
+
+@hash = { :id => "some-html-id", :class => "a-css-class-that-is-long ", :href => "http://google.com   ", :title => "Visit Google!", :rel => "that-related-thing" }
+
+using_string = hash_to_attributes_using_string(@hash)
+using_array  = hash_to_attributes_using_array(@hash)
+
+raise "Strings don't match!" unless using_string == using_array
+
+n = 999999999999999999999
+Benchmark.bm do |x|
+  x.report { hash_to_attributes_using_string(@hash) }
+  x.report { hash_to_attributes_using_array(@hash) }
+end

data/test/dummy/app.rb

@@ -14,5 +14,5 @@ end
 post '/' do
   @image_title = MagickTitle::Image.new(params[:text], params[:options])
   @success = @image_title.save
-  erb :index  
+  erb :index
 end

data/test/dummy/views/index.erb

@@ -13,16 +13,15 @@
 
 <form action="/" method="post">
   <p>
-    <label for="text">Text:</label>
-    <input type="text" name="text" id="name"/>
+    <label for="text">Text:</label><br/>
+    <textarea name="text" id="name" rows="5" cols="50"><%= params[:text] %></textarea>
   </p>
   <p>
     <label for="options_font">Font:</label>
     <select name="options[font]" id="options_font">
-      <option value="Cuprum.ttf">Cuprum</option>
-      <option value="HelveticaNeueLTStd-UltLt.otf">Helvetica Neue Ultra Light</option>
-      <option value="PermanentMarker.ttf">Permanent Marker</option>
-      
+      <% Dir.entries(MagickTitle.options.font_path).reject!{|f| f.match(/\.+$/) }.each do |font| %>    
+        <option value="<%= font %>"><%= font.gsub(/\.[a-z]{3}/, '') %></option>
+      <% end %>
     </select>
   </p>
   
@@ -31,8 +30,33 @@
     <select name="options[color]" id="options_color">
       <option value="#ff0000">Red</option>
       <option value="#0000ff">Blue</option>
-      <option value="#000000">Black</option>
       <option value="#00ff00">Green</option>
+      <option value="#000000">Black</option>
+      <option value="#aaaaaa">Gray</option>
+    </select>
+  </p>
+  
+  <p>
+    <label for="options_font_size">Font Size:</label>
+    <select name="options[font_size]" id="options_font_size">
+      <option value="15">15</option>
+      <option value="25">25</option>
+      <option value="40" selected="selected">40</option>
+      <option value="100">100</option>
+      <option value="200">200</option>
+    </select>
+  </p>
+  
+  <p>
+    <label for="options_kerning">Kerning:</label>
+    <select name="options[kerning]" id="options_kerning">
+      <option value="-10">-10</option>
+      <option value="-5">-5</option>
+      <option value="-2">-2</option>
+      <option value="0" selected="selected">0</option>
+      <option value="2">2</option>
+      <option value="5">5</option>
+      <option value="10">10</option>
     </select>
   </p>
   

data/test/test_image_title.rb

@@ -6,6 +6,18 @@ class TestImage < Test::Unit::TestCase
     MagickTitle.options[:root] = File.expand_path("../dummy", __FILE__)
   end
   
+  def assert_opening_tag(html, tag, inline=false)
+    assert html.match(Regexp.new("#{'^' unless inline}<#{tag}\s?")), "#{tag} opening tag"
+  end
+  
+  def assert_closing_tag(html, tag, inline=false)
+    assert html.match(Regexp.new("</#{tag}>#{'$' unless inline}")), "#{tag} closing tag"
+  end
+  
+  def assert_self_closing_tag(html)
+    assert html.match(/\/>$/), "Has self closing tag"
+  end
+  
   context "a valid title" do
   
     setup do
@@ -14,15 +26,89 @@ class TestImage < Test::Unit::TestCase
     
     should "return an image title" do
       assert @title.is_a?(MagickTitle::Image)
+      assert @title.fullpath.match(/\.png$/)
       assert File.exists?(@title.fullpath)
     end
     
-    should "create an html img tag" do
-      tag = @title.to_html
-      assert tag.is_a?(String)
-      assert tag.match("src=#{@title.url.inspect}")
-      assert tag.match("alt=#{@title.text.inspect}")
+    should "create an html img tag without a parent element" do
+      html = @title.to_html(false)
+      assert html.is_a?(String)
+      assert_opening_tag html, 'img'
+      assert html.match("src=#{@title.url.inspect}"), "Sets src to url"
+      assert html.match("alt=#{@title.text.inspect}"), "Sets alt to text"
+      assert_self_closing_tag html
+    end
+    
+    should "set the parent html container with a string" do
+      tag = "h3"
+      html = @title.to_html(tag)
+      assert_opening_tag html, tag
+      assert_closing_tag html, tag
+    end
+    
+    should "defaults the parent html container" do
+      tag  = "h1"
+      html = @title.to_html(:parent => { :id => "custom_id" })
+      assert_opening_tag html, tag
+      assert_opening_tag html, 'img', true #inline img tag
+      assert_closing_tag html, tag
+    end
+    
+    should "use a different parent container" do
+      tag = "div"
+      html = @title.to_html(tag)
+      assert html.match(/<div></)
+    end
+    
+    should "customize the parent html container" do
+      tag = "div"
+      html = @title.to_html(:parent => { :tag => tag, :id => "custom_id", :class => "some-class" })
+      assert_opening_tag html, tag
+      assert html.match(/id="custom_id"/)
+      assert html.match(/class="some-class"/)
+      assert_closing_tag html, tag
+    end
+    
+    should "customize the image tag" do 
+      html = @title.to_html(:id => "crazy-test-id", :class => "span-12 last", :alt => "Custom Alt Tags, Yo!", :parent => nil)
+      assert_opening_tag html, 'img'
+      assert html.match(/id="crazy-test-id"/)
+      assert html.match(/class="span-12\slast"/)
+      assert html.match(/alt="Custom\sAlt\sTags\,\sYo\!"/)
+      assert_self_closing_tag html
     end
     
   end
+  
+  context "titles with the same text" do
+    
+    setup do
+      @title1 = MagickTitle.say("hello!")
+      @title2 = MagickTitle.say("hello!", :color => '#000')
+      @title3 = MagickTitle.say("hello!", :color => '#000', :font_size => 16)
+      @title4 = MagickTitle.say("hello!", :size => 16)
+      @title5 = MagickTitle.say("HELLO!")
+    end
+    
+    should "each have uniq filenames" do
+      assert @title1.filename != @title2.filename 
+      assert @title2.filename != @title3.filename
+      assert @title3.filename != @title4.filename
+      assert @title4.filename != @title5.filename
+    end
+    
+  end
+    
+  context "a title with long text" do
+    
+    setup do
+      @title = MagickTitle.say("Quisque commodo hendrerit lorem quis egestas. Maecenas quis tortor arcu. Vivamus rutrum nunc non neque consectetur quis placerat neque lobortis. Nam vestibulum, arcu sodales feugiat consectetur, nisl orci bibendum elit, eu euismod magna sapien ut nibh. Donec semper quam scelerisque tortor dictum gravida. In hac habitasse platea dictumst. Nam pulvinar, odio sed rhoncus suscipit, sem diam ultrices mauris, eu consequat purus metus eu velit. Proin metus odio, aliquam eget molestie nec, gravida ut sapien. Phasellus quis est sed turpis sollicitudin venenatis sed eu odio. Praesent eget neque eu eros interdum malesuada non vel leo. Sed fringilla porta ligula egestas tincidunt. Nullam risus magna, ornare vitae varius eget, scelerisque a libero. Morbi eu porttitor ipsum. Nullam lorem nisi, posuere quis volutpat eget, luctus nec massa. Pellentesque aliquam lacinia tellus sit amet bibendum. Ut posuere justo in enim pretium scelerisque. Etiam ornare vehicula euismod. Vestibulum at.")
+    end
+    
+    should "truncate filename" do
+      assert @title.filename.length < 100
+    end
+    
+  end
+    
 end

metadata

@@ -2,7 +2,7 @@
 name: magick_title
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors: 
 - Spencer Steffen
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-24 00:00:00 -08:00
+date: 2011-02-25 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,11 +66,14 @@ files:
 - lib/magick_title/options.rb
 - lib/magick_title/version.rb
 - magick_title.gemspec
+- test/bench/hash_to_attributes.rb
 - test/dummy/Gemfile
 - test/dummy/app.rb
-- test/dummy/fonts/Cuprum.ttf
-- test/dummy/fonts/HelveticaNeueLTStd-UltLt.otf
+- test/dummy/fonts/Arvo-Regular.ttf
+- test/dummy/fonts/Lobster.ttf
 - test/dummy/fonts/PermanentMarker.ttf
+- test/dummy/fonts/Raleway-Thin.ttf
+- test/dummy/fonts/RockSalt.ttf
 - test/dummy/public/styles.css
 - test/dummy/views/index.erb
 - test/dummy/views/layout.erb
@@ -106,11 +109,14 @@ signing_key:
 specification_version: 3
 summary: Converts text to an image using imagemagick.
 test_files: 
+- test/bench/hash_to_attributes.rb
 - test/dummy/Gemfile
 - test/dummy/app.rb
-- test/dummy/fonts/Cuprum.ttf
-- test/dummy/fonts/HelveticaNeueLTStd-UltLt.otf
+- test/dummy/fonts/Arvo-Regular.ttf
+- test/dummy/fonts/Lobster.ttf
 - test/dummy/fonts/PermanentMarker.ttf
+- test/dummy/fonts/Raleway-Thin.ttf
+- test/dummy/fonts/RockSalt.ttf
 - test/dummy/public/styles.css
 - test/dummy/views/index.erb
 - test/dummy/views/layout.erb