magick_title 0.1.3 → 0.1.4

data/lib/magick_title.rb

@@ -30,10 +30,8 @@ module MagickTitle
   #   MagickTitle.image("Hello!")
   #   MagickTitle.say("Hi", :refresh => true)
   #
-  def image(text, opts={})
-    title = ::MagickTitle::Image.new(text, opts)
-    title.save unless title.options.cache && File.exists?(title.fullpath)
-    title
+  def image(*args)
+    MagickTitle::Image.create(*args)
   end
   alias :say :image
   

data/lib/magick_title/image.rb

@@ -1,5 +1,4 @@
 require 'digest/sha1'
-require 'fileutils' unless defined?(FileUtils)
 
 module MagickTitle
 
@@ -22,32 +21,64 @@ module MagickTitle
     attr_reader :url
     
     
+    # Creates an instance of MagickTitle::Image
+    #
+    #   MagickTitle::Image.create("text")
+    #   MagickTitle::Image.create("large", :font_size => 60)
+    #
+    def self.create(*args)
+      title = new(*args)
+      return unless title.save
+      title
+    end
+    
+    
     # Initializes a new image title with a string
     def initialize(text="", opts={})
       update(text, opts)
     end
     
     
-    # updates the image title to reflect new text
+    # updates the image title to reflect new text and returns self
     def update(text, opts={})
       @text = text
-      return false unless valid?
+      return unless valid?
+      
+      # save the fullpath so we can delete it later
+      @old_path = fullpath
+      
       @options = (@options || MagickTitle.options).merge(opts.symbolize_keys)
       @filename = filename_from_options #unique_filename(@text)
       @path = options.destination
       @url = File.join((@path.match(/public(\/.*)/) || ['', './'])[1].to_s, @filename)
+      self
     end
     
     
-    
-    # saves title and generates image
+    # Saves title and generates image
     def save
-      return false unless valid?
+      # validate
+      return unless valid?
+
+      # check for caching
+      return true if options.cache && !dirty?
+      
+      # delete if an old title exists
+      delete(@old_path)
+      
+      # delete current image
+      delete(fullpath)
+      
       FileUtils.mkdir_p(path)
       run('convert', title_command_string(fullpath))
       File.exists?(fullpath)
     end
     
+    # Deletes the specified image
+    def delete(file=fullpath)
+      FileUtils.rm(file) if file && File.exists?(file)
+    end
+    
     
     # Checks if the image title is valid
     def valid?
@@ -55,8 +86,21 @@ module MagickTitle
     end
     
     
+    # Checks if the image title needs to be saved
+    def dirty?
+      !exists? || (@old_path && @old_path != fullpath)
+    end
+    
+    # Checks if the specified file exists
+    def exists?(file=fullpath)
+      return unless file
+      file = [file, options.extension].join(".") unless file.match(/\.[a-z]{3,4}$/)
+      File.exists?(file)
+    end
+    
     # Returns the full path to the file
     def fullpath
+      return unless path && filename
       File.join(path, filename)
     end
     
@@ -147,22 +191,16 @@ module MagickTitle
       # creates a unique filename for the title's text
       def unique_filename
         file = fileize_text(@text)
-        exists = exists_in_destination? file
+        exists = exists? file
         dupe, count = nil, 0
         while exists do
           count += 1
           dupe = "#{file}_#{count}"
-          exists = exists_in_destination? dupe
+          exists = exists? dupe
         end
         dupe || file
       end
       
-      
-      # Checks if file exists in the destination option
-      def exists_in_destination?(file)
-        file = [file, options.extension].join(".") unless file.match(/\.[a-z]{3,4}$/)
-        File.exists?(File.join(options.destination, file))
-      end
           
   end # Image
   

data/lib/magick_title/options.rb

@@ -33,6 +33,7 @@ module MagickTitle
         :font_size => 50,
         :destination => Proc.new{ File.join MagickTitle.root, "public/system/titles" },
         :extension => "png",
+        :text_transform => nil,
         :width => 800,
         :height => nil,
         :background_color => '#ffffff',

data/lib/magick_title/version.rb

@@ -1,3 +1,3 @@
 module MagickTitle
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/test/dummy/Gemfile

@@ -1,6 +1,4 @@
 source "http://rubygems.org"
 
 gem "sinatra"
-gem "magick_title", "0.1.2"
-
-#:path => File.expand_path("../../../", __FILE__)
+gem "magick_title", :path => File.expand_path("../../../", __FILE__)

data/test/helper.rb

@@ -3,4 +3,15 @@ ENV["environment"] = "test"
 require 'test/unit'
 #require 'rack/test'
 require 'shoulda'
-require 'magick_title'
+require 'magick_title'
+require 'fileutils'
+
+class Test::Unit::TestCase
+
+  def setup
+    super
+    MagickTitle.options[:root] = File.expand_path("../dummy", __FILE__)
+    FileUtils.rm_r MagickTitle.options.destination if Dir.exists?(MagickTitle.options.destination)
+  end
+
+end

data/test/test_image.rb

@@ -0,0 +1,194 @@
+require 'helper'
+
+class TestImage < Test::Unit::TestCase
+
+  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
+  
+  should "create an instance of MagickTitle::Image" do
+    @title = MagickTitle::Image.create("create using class method")
+  end
+  
+  context "an invalid title" do
+  
+    setup do
+      @title = MagickTitle::Image.new("")
+    end
+  
+    should "not allow empty string" do
+      assert !@title.valid?
+      assert !@title.save
+      assert !@title.fullpath
+    end
+    
+    should "not allow update" do
+      assert !@title.update("")
+      assert !@title.save
+      assert !@title.fullpath
+    end
+    
+    should "allow update to valid title" do
+      assert @title.update("Hello!")
+      assert @title.save
+      assert File.exists?(@title.fullpath)
+    end
+    
+  end
+    
+  context "a valid title" do
+  
+    setup do
+      @title = MagickTitle::Image.new("hello!")
+    end
+    
+    should "save and create an image" do
+      assert @title.save
+      assert @title.fullpath.match(/\.png$/)
+      assert File.exists?(@title.fullpath)
+    end
+    
+    should "delete it's image" do
+      assert @title.save
+      assert @title.delete
+      assert !File.exists?(@title.fullpath)
+    end
+    
+    should "downcase the image tag text" 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 "an existing title" do
+  
+    setup do
+      @title = MagickTitle::Image.create("hello!")
+    end
+    
+    should "cache when asked to" do
+      # make sure cache is turned ON
+      assert @title.options.cache
+      mod = File::mtime(@title.fullpath)
+      
+      # delay for timestamp..
+      sleep 1
+      
+      # make sure we really don't need to update
+      assert !@title.dirty?
+      @title.save
+      
+      mod2 = File::mtime(@title.fullpath)
+      assert_equal mod, mod2
+    end
+    
+    should "not cache when asked to" do
+      # make sure cache is turned OFF
+      @title.options[:cache] = false
+      assert !@title.options.cache
+      mod = File::mtime(@title.fullpath)
+      
+      # delay for timestamp..
+      sleep 1
+      
+      # make sure we really don't need to update
+      assert !@title.dirty?
+      @title.save
+      
+      mod2 = File::mtime(@title.fullpath)
+      assert mod != mod2
+    end
+    
+    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::Image.create("hello!")
+      @title2 = MagickTitle::Image.create("hello!", :color => '#000')
+      @title3 = MagickTitle::Image.create("hello!", :color => '#000', :font_size => 16)
+      @title4 = MagickTitle::Image.create("hello!", :size => 16)
+      @title5 = MagickTitle::Image.create("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
+      assert @title5.filename != @title1.filename
+    end
+    
+  end
+    
+  context "a title with long text" do
+    
+    should "truncate filename" do
+      @title = MagickTitle::Image.create("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.")
+      assert @title.filename.length < 100
+    end
+    
+  end
+    
+end

data/test/test_magick_title.rb

@@ -1,34 +1,14 @@
 require 'helper'
 
-class TestImage < Test::Unit::TestCase
+class TestMagickTitle < Test::Unit::TestCase
 
-  def setup
-    MagickTitle.options[:root] = File.expand_path("../dummy", __FILE__)
-  end
-  
-
-  should "not allow empty string" do
-    @title = MagickTitle::Image.new("")
-    assert !@title.valid?
-    assert !@title.save
-  end
-  
-  
-  context "a valid image title" do
+  should "create an instance of MagickTitle::Image" do
     
-    setup do
-      @title = MagickTitle::Image.new("hello")
-    end
+    @title = MagickTitle.say("Hello Magick Title!")
     
-    should "allow valid string" do
-      assert @title.valid?
-    end
+    assert @title.is_a?(MagickTitle::Image)
+    assert File.exists?(@title.fullpath)
     
-    should "save a valid title" do
-      assert @title.save
-      assert File.exists?(@title.fullpath)
-    end
-        
   end
   
 end

metadata

@@ -2,7 +2,7 @@
 name: magick_title
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Spencer Steffen
@@ -80,7 +80,7 @@ files:
 - test/dummy/views/index.erb
 - test/dummy/views/layout.erb
 - test/helper.rb
-- test/test_image_title.rb
+- test/test_image.rb
 - test/test_magick_title.rb
 has_rdoc: true
 homepage: https://github.com/citrus/magick_title
@@ -125,5 +125,5 @@ test_files:
 - test/dummy/views/index.erb
 - test/dummy/views/layout.erb
 - test/helper.rb
-- test/test_image_title.rb
+- test/test_image.rb
 - test/test_magick_title.rb

data/test/test_image_title.rb

@@ -1,114 +0,0 @@
-require 'helper'
-
-class TestImage < Test::Unit::TestCase
-
-  def setup
-    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
-      @title = MagickTitle.say("hello!")
-    end
-    
-    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 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