magick_title 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.DS_Store
+Gemfile.lock
+pkg/*
+test/dummy/public/system

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in magick_title.gemspec
+gemspec

data/README.md

@@ -0,0 +1,49 @@
+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.
+
+** ----- under construction! ----- **
+   
+Usage
+-----
+
+Using MagickTitle is easy:
+
+    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>
+
+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">
+
+
+To just get an instance of MagickTitle::Image:
+
+    title = MagickTitle.say("Hello!")
+    
+    puts title.filename #=> "hello.png"
+    puts title.url #=> "/system/titles/hello.png"
+
+
+More to come!
+
+   
+To Do
+-----
+
+* Write tests
+* Write documentation
+* Auto ActiveRecord integration (this will be a seperate HasImage gem)
+* Clean up and publish demo app
+
+
+License
+-------
+
+Copyright (c) 2011 Spencer Steffen, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test' << 'lib'
+  t.verbose = true
+end
+
+desc "Default Task"
+task :default => [ :test ]

data/lib/magick_title/hash.rb

@@ -0,0 +1,17 @@
+class Hash
+  # Stolen from rails 
+  def symbolize_keys
+    self.inject({}){|result, (key, value)|
+      new_key = case key  
+                when String then key.to_sym  
+                else key  
+                end  
+      new_value = case value
+                  when Hash then value.symbolize_keys
+                  else value
+                  end  
+      result[new_key] = new_value  
+      result
+    }  
+  end  
+end

data/lib/magick_title/image.rb

@@ -0,0 +1,169 @@
+require 'fileutils' unless defined?(FileUtils)
+
+module MagickTitle
+
+  class Image
+    
+    # The hash of options used for building
+    attr_accessor :text
+    
+    # The hash of options used for building
+    # This hash is subclassed as Options and has some fancy features
+    attr_accessor :options
+    
+    # File path to destination folder
+    attr_accessor :path  
+    
+    # Returns the filename of the title
+    attr_reader   :filename
+    
+    # Relative url to the image 
+    attr_reader :url
+    
+    
+    # Initializes a new image title with a string
+    def initialize(text="", opts={})
+      update(text, opts)
+      super
+    end
+    
+    
+    # updates the image title to reflect new text
+    def update(text, opts={})
+      @text = text
+      return false unless valid?
+      @options = (@options || MagickTitle.options).merge(opts.symbolize_keys)
+      @filename = unique_filename(@text)
+      @path = options.destination
+      @url = File.join((@path.match(/public(\/.*)/) || ['', './'])[1].to_s, @filename)
+    end
+    
+    
+    
+    # saves title and generates image
+    def save
+      return false unless valid?
+      FileUtils.mkdir_p(path)
+      run('convert', title_command_string)
+      File.exists?(fullpath)
+    end
+    
+    
+    # Checks if the image title is valid
+    def valid?
+      1 < @text.strip.length
+    end
+    
+    
+    # Returns the full path to the file
+    def fullpath
+      File.join(path, filename)
+    end
+    
+    
+    
+    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)
+      parent = opts.delete(:parent)
+      parent = { :tag => parent } if parent.is_a?(String)
+      tag = %(<img #{hash_to_attributes(opts)}/>)
+      if parent
+        ptag = parent.delete(:tag)
+        tag = %(<#{ptag} #{hash_to_attributes(parent)}>#{tag}</#{ptag}>)
+      end      
+      tag
+    end
+    
+    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
+    end
+    
+    
+    private
+    
+    
+      # builds an imagemagick identify command to the specified fild
+      def info_command_string(file)
+        "-format '%b,%w,%h' #{file}"
+      end
+      
+      # builds an imagemagick command based on the supplied options 
+      def title_command_string
+        %(
+          -trim
+          -antialias
+          -background '#{options.background_color}#{options.background_alpha}'
+          -fill '#{options.color}'
+          -font #{options.font_path}/#{options.font}
+          -pointsize #{options.font_size}
+          -size #{options.width}x#{options.height}
+          -weight #{options.weight}
+          -kerning #{options.kerning}
+          caption:'#{@text}'
+          #{fullpath}
+        ).gsub(/[\n\r\s]+/, ' ')
+      end 
+      
+      # Cleans and runs the supplied command       
+      # (stolen from paperclip)
+      def run(cmd, params)
+        command = [path_for_command(cmd), params.to_s.gsub(/\\|\n|\r/, '')].join(" ")
+        puts command if options.log_command
+        `#{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
+      def fileize_text(text)
+        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)
+        exists = exists_in_destination? file
+        dupe, count = nil, 0
+        while exists do
+          count += 1
+          dupe = "#{file}_#{count}"
+          exists = exists_in_destination? dupe
+        end
+        "#{dupe || file}.#{options.extension}"
+      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.exists?(File.join(options.destination, file))
+      end
+          
+  end # Image
+  
+end # MagickTitle

data/lib/magick_title/options.rb

@@ -0,0 +1,72 @@
+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
+      store :root, defined?(::Rails) ? ::Rails.root.to_s : "./"
+      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_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
+      }
+    end
+    
+    # Sets and option and converts its key to a symbol
+    def []=(key, value)
+      key = key.to_sym
+      raise ArgumentError, "MagickTitle::InvalidOption: #{key} is not an available option." unless defaults.keys.include?(key)      
+      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.
+    #
+    #   Options.foo #=> "bar"
+    #   Options.fuz #=> method missing error
+    #
+    def method_missing(method, *args, &block)
+      key = method.to_sym
+      val = fetch(key) # if has_key? key
+      val.nil? ? nil : val.is_a?(Proc) ? val.call : val
+    end
+    
+  end
+  
+end

data/lib/magick_title/version.rb

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

data/lib/magick_title.rb

@@ -0,0 +1,40 @@
+require 'magick_title/hash'
+require 'magick_title/options'
+require 'magick_title/image'
+
+module MagickTitle
+
+  extend self
+  
+  # A shortcut to options[:root]
+  def root
+    options.root
+  end
+  
+  # Returns the options hash
+  def options
+    @options ||= Options.new
+  end
+  
+  # Sets the options hash
+  def options=(value)
+    raise ArgumentError, "Magick Title options must be a Hash" unless value.is_a?(Hash)
+    value.each_pair do |key, value|
+      options[key] = value
+    end
+    options
+  end
+ 
+  # A helper tag to create or fetch and image title
+  #
+  #   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
+  end
+  alias :say :image
+  
+end # MagickTitle

data/magick_title.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "magick_title/version"
+
+Gem::Specification.new do |s|
+  s.name        = "magick_title"
+  s.version     = MagickTitle::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Spencer Steffen"]
+  s.email       = ["spencer@citrusme.com"]
+  s.homepage    = "https://github.com/citrus/magick_title"
+  s.summary     = %q{Converts text to an image using imagemagick.}
+  s.description = %q{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.}
+
+  s.rubyforge_project = "magick_title"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency 'shoulda', '2.11.3'
+  s.add_development_dependency 'rack-test', '0.5.7'
+  s.add_development_dependency 'sinatra', '1.1.0'
+  
+end

data/test/dummy/Gemfile

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

data/test/dummy/app.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+Bundler.require if defined?(Bundler)
+
+
+MagickTitle.options = { :font_size => 56 }
+
+
+use Rack::Static
+
+get '/' do
+  erb :index
+end
+
+post '/' do
+  @image_title = MagickTitle::Image.new(params[:text], params[:options])
+  @success = @image_title.save
+  erb :index  
+end

data/test/dummy/public/styles.css

@@ -0,0 +1,31 @@
+body {
+  font-family: "HelveticaNeue", Helvetica, Arial, sans-serif;
+  color: #080603;
+}
+a {
+  text-decoration: none;
+  color: #68962c;
+}
+.container {
+  width: 500px;
+  margin: 0 auto;
+}
+.header {
+  border-bottom: 1px solid #ddd;
+}
+.header a {
+  display: inline-block;
+  padding: 4px 10px;
+  background-color: #eee;
+}
+
+.flash {
+  padding: 10px 0;
+  border-bottom: 1px solid #ddd;
+}
+.flash.notice {
+  color: #68962c;
+}
+.flash.error {
+  color: #c00e0e;
+}

data/test/dummy/views/index.erb

@@ -0,0 +1,42 @@
+<% if @success && @image_title %>
+  <h1>Success!</h1>
+  <img src=<%= @image_title.url.inspect %> alt=<%= @image_title.text.inspect %>/>
+<% elsif @success === false %>
+  <h1>Failed.</h1>
+<% else %>
+  <%= MagickTitle.say("Hello!").to_html %>
+  <h2><%= MagickTitle.say("Welcome to MagickTitle!", :cache => false, :font => 'PermanentMarker.ttf', :font_size => 20, :color => '#999').to_html(false) %></h2>
+<% end %>
+
+
+<h2>Generate an image title!</h2>
+
+<form action="/" method="post">
+  <p>
+    <label for="text">Text:</label>
+    <input type="text" name="text" id="name"/>
+  </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>
+      
+    </select>
+  </p>
+  
+  <p>
+    <label for="options_color">Color:</label>
+    <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>
+    </select>
+  </p>
+  
+  <p>
+    <input type="submit" value="generate"/>
+  </p>
+</form>

data/test/dummy/views/layout.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Magick Title Demo</title>
+  <link rel="stylesheet" type="text/css" href="styles.css" />
+</head>
+<body>
+
+<div class="container">
+
+  <%= yield %>
+
+</div>
+
+</body>
+</html>

data/test/helper.rb

@@ -0,0 +1,6 @@
+ENV["environment"] = "test"
+
+require 'test/unit'
+#require 'rack/test'
+require 'shoulda'
+require 'magick_title'

data/test/test_image_title.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestImage < Test::Unit::TestCase
+
+  def setup
+    MagickTitle.options[:root] = File.expand_path("../dummy", __FILE__)
+  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 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}")
+    end
+    
+  end
+end

data/test/test_magick_title.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+class TestImage < 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
+    
+    setup do
+      @title = MagickTitle::Image.new("hello")
+    end
+    
+    should "allow valid string" do
+      assert @title.valid?
+    end
+    
+    should "save a valid title" do
+      assert @title.save
+      assert File.exists?(@title.fullpath)
+    end
+        
+  end
+  
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: magick_title
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Spencer Steffen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.11.3
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.5.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+  type: :development
+  version_requirements: *id003
+description: 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.
+email: 
+- spencer@citrusme.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/magick_title.rb
+- lib/magick_title/hash.rb
+- lib/magick_title/image.rb
+- lib/magick_title/options.rb
+- lib/magick_title/version.rb
+- magick_title.gemspec
+- test/dummy/Gemfile
+- test/dummy/app.rb
+- test/dummy/fonts/Cuprum.ttf
+- test/dummy/fonts/HelveticaNeueLTStd-UltLt.otf
+- test/dummy/fonts/PermanentMarker.ttf
+- test/dummy/public/styles.css
+- test/dummy/views/index.erb
+- test/dummy/views/layout.erb
+- test/helper.rb
+- test/test_image_title.rb
+- test/test_magick_title.rb
+has_rdoc: true
+homepage: https://github.com/citrus/magick_title
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: magick_title
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Converts text to an image using imagemagick.
+test_files: 
+- test/dummy/Gemfile
+- test/dummy/app.rb
+- test/dummy/fonts/Cuprum.ttf
+- test/dummy/fonts/HelveticaNeueLTStd-UltLt.otf
+- test/dummy/fonts/PermanentMarker.ttf
+- test/dummy/public/styles.css
+- test/dummy/views/index.erb
+- test/dummy/views/layout.erb
+- test/helper.rb
+- test/test_image_title.rb
+- test/test_magick_title.rb