has_magick_title 0.1.0.rc1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,23 @@
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, 
+      this list of conditions and the following disclaimer in the documentation 
+      and/or other materials provided with the distribution.
+    * Neither the name of the Rails Dog LLC nor the names of its 
+      contributors may be used to endorse or promote products derived from this 
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,85 @@
+Has Magick Title
+================
+ 
+Installation
+------------
+
+Since has_magick_title is to be used with rails, we'll install it by adding the following to your Gemfile and running the `bundle` command.
+
+    gem 'has_magick_title', :git => 'git://github.com/citrus/has_magick_title.git'
+    
+Now bundle up:
+
+    bundle
+
+
+Usage
+-----
+
+To automagically generate your model's title attribute into an image, just call the `has_magick_title` class method.
+
+    # assume the defaults (:attribute => :title)
+    class Post < ActiveRecord::Base
+      has_magick_title      
+    end
+    
+
+    # custom attribute and magick_title options
+    class Person < ActiveRecord::Base
+      has_magick_title :name,
+        :color => "#e00053", 
+        :font_size => 19
+    end
+
+    # custom attribute and magick_title style
+    
+    MagickTitle.style :h1 do
+      font_size   50
+      line_height -10
+    end
+        
+    class Person < ActiveRecord::Base
+      has_magick_title :name, :h1
+    end
+
+
+### See [magick_title](https://github.com/citrus/magick_title) for more...
+
+
+Testing
+-------
+
+Testing for has_magick_title is done with [shoulda](https://github.com/thoughtbot/shoulda), [spork](https://github.com/timcharper/spork) and [dummier](https://github.com/citrus/dummier).
+
+Start by cloning the project:
+
+    git clone git://github.com/citrus/has_magick_title.git
+    cd has_magick_title
+    
+    
+To get your environment setup, just run the following:
+
+    bundle
+    bundle exec dummier
+    
+    
+Now run the unit tests with rake:
+
+    rake
+    
+    
+If you'd like to spork, you probably already know what to do. Otherwise, skip the rake step and run spork instead:
+
+    spork
+    
+
+Now in another window:
+
+    cd /to/where/you/cloned/has_magick_title
+    testdrb test/unit/*.rb
+
+
+License
+-------
+
+Copyright (c) 2011 Spencer Steffen and Citrus, released under the New BSD License All rights reserved.

data/Rakefile

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

data/has_magick_title.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "has_magick_title/version"
+
+Gem::Specification.new do |s|
+  s.name        = "has_magick_title"
+  s.version     = HasMagickTitle::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Spencer Steffen"]
+  s.email       = ["spencer@citrusme.com"]
+  s.homepage    = "https://github.com/citrus/has_magick_title"
+  s.summary     = %q{Automagically creates an image of your rails model's title using magick_title.}
+  s.description = %q{Automagically creates an image of your rails model's title using magick_title.}
+
+  s.rubyforge_project = "has_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_dependency 'magick_title',                 '>= 0.2.0.rc1'
+  
+  s.add_development_dependency 'rails',            '>= 3.0.0'
+  s.add_development_dependency 'sqlite3',          '>= 1.3.3'
+  s.add_development_dependency 'shoulda',          '2.11.3'
+  s.add_development_dependency 'dummier',          '0.1.0'
+  s.add_development_dependency('spork',            '>= 0.9.0.rc7')
+  s.add_development_dependency('spork-testunit',   '>= 0.0.5')
+  
+end

data/lib/dummy_hooks/after_app_generator.rb

@@ -0,0 +1,20 @@
+prepend_file 'config/application.rb', %(require "rake"
+)
+
+run "rails g scaffold post title:string"
+
+gsub_file "app/models/post.rb", "end", %(
+  has_magick_title
+  
+end)
+
+gsub_file "config/routes.rb", "resources :posts", %(
+  resources :posts
+  root :to => "posts#index")
+
+gsub_file "app/views/posts/show.html.erb", "<%= @post.title %>", %(
+  <%= magick_title_for @post %>)
+   
+
+say_status 'copying', 'sample fonts to dummy'
+FileUtils.cp_r File.join(root_path, "test/fonts"), destination_path

data/lib/dummy_hooks/after_migrate.rb

@@ -0,0 +1 @@
+rake "db:migrate", :env => "development"

data/lib/dummy_hooks/before_migrate.rb

@@ -0,0 +1 @@
+run "rails g has_magick_title:install"

data/lib/generators/has_magick_title/install_generator.rb

@@ -0,0 +1,28 @@
+module HasMagickTitle
+  module Generators
+    class InstallGenerator < Rails::Generators::Base 
+        include Rails::Generators::Migration      
+    
+      def self.count!
+        @count ||= 0
+        (@count += 1) * 3
+      end
+    
+      def self.next_migration_number(path)
+        @time ||= Time.new.utc
+        if ActiveRecord::Base.timestamped_migrations
+          (@time + self.count!).strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+      
+      desc "Installs required migrations for spree_essentials"
+      source_root File.expand_path("../../templates", __FILE__)
+      
+      def copy_migrations
+        migration_template "add_has_magick_title.rb", "db/migrate/add_has_magick_title.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/add_has_magick_title.rb

@@ -0,0 +1,16 @@
+class AddHasMagickTitle < ActiveRecord::Migration
+  def self.up
+    create_table :image_titles do |t|
+      t.references :imagable, :polymorphic => true
+      t.string     :text
+      t.string     :filename
+      t.integer    :width
+      t.integer    :height
+      t.integer    :size
+    end
+  end
+
+  def self.down
+    drop_table :image_titles
+  end
+end

data/lib/has_magick_title.rb

@@ -0,0 +1,70 @@
+require 'magick_title'
+require 'magick_title/extension'
+require 'has_magick_title/image_title'
+require 'has_magick_title/view_helper'
+
+module HasMagickTitle
+
+  module Base
+  
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      
+      def has_magick_title(attribute=:title, options={})
+        include InstanceMethods
+        
+        cattr_accessor :magick_title_options
+        
+        if attribute.is_a? Hash
+          options   = attribute
+          attribute = :title
+        end
+        
+        if options.is_a? Symbol
+          self.magick_title_options = MagickTitle.styles[options]
+        elsif options.is_a? Hash      
+          self.magick_title_options = MagickTitle.options.merge(options)
+        else 
+          raise ArgumentError, "has_magick_title options must be a Symbol or Hash"
+        end
+        
+        self.magick_title_options.merge!(:attribute => attribute)
+            
+        has_one :image_title, :as => :imagable, :autosave => true, :dependent => :destroy
+        before_save :refresh_magick_title
+                
+      end
+    
+    end
+    
+    module InstanceMethods
+    
+      def has_magick_title?
+        !image_title.nil?
+      end
+      alias :has_image_title? :has_magick_title?
+    
+      def magick_title_text
+        send magick_title_options[:attribute]
+      end
+      
+      def refresh_magick_title(opts={})
+        self.image_title = build_image_title unless has_magick_title?
+        if opts[:force] || (image_title.new_record? || send("#{magick_title_options[:attribute]}_changed?"))
+          image_title.send(:delete_magick_title)
+          image = MagickTitle::Image.create(magick_title_text, magick_title_options)
+          image_title.update_attributes(image.identify.merge(:filename => image.filename))
+        end                       
+      end
+        
+    end
+  
+  end
+  
+end
+
+ActiveRecord::Base.send(:include, HasMagickTitle::Base)
+ActionView::Helpers.send(:include, HasMagickTitle::ViewHelper)

data/lib/has_magick_title/image_title.rb

@@ -0,0 +1,25 @@
+class ImageTitle < ActiveRecord::Base
+  
+  belongs_to :imagable, :polymorphic => true
+  
+  before_destroy :delete_magick_title
+  
+  validate :filename, :presence => true
+  validate :width, :height, :size, :numericality => true
+  
+  def url
+    File.join("/system/titles", filename)
+  end
+  
+  def full_path
+    File.join(Rails.root, "public", url)
+  end
+  
+  private
+   
+    def delete_magick_title
+      return if new_record? || filename.nil? || !File.exists?(full_path)
+      FileUtils.rm(full_path)
+    end
+    
+end

data/lib/has_magick_title/version.rb

@@ -0,0 +1,3 @@
+module HasMagickTitle
+  VERSION = "0.1.0.rc1"
+end

data/lib/has_magick_title/view_helper.rb

@@ -0,0 +1,13 @@
+module HasMagickTitle
+  module ViewHelper
+  
+    # Creates and HTML image tag with the options provided
+    def magick_title_for(record, options={})
+      opts = record.magick_title_options[:to_html].merge(options)
+      record.refresh_magick_title unless record.has_image_title? 
+      return "[magick_title error]" unless record.has_image_title?
+      MagickTitle::Renderer.to_html(record.magick_title_text, record.image_title.url, opts).html_safe
+    end        
+  
+  end
+end

data/lib/magick_title/extension.rb

@@ -0,0 +1,11 @@
+MagickTitle::Options.class_eval do
+  
+  # Alias the defaults for use later
+  alias :standard_defaults :defaults
+  
+  # Overwrite defaults to include the attribute option
+  def defaults
+    standard_defaults.merge(:attribute => :title)
+  end
+    
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+require 'spork'
+
+Spork.prefork do
+  
+  require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+  require "rails/test_help"
+  require "shoulda"
+  require "sqlite3"
+  
+  Rails.backtrace_cleaner.remove_silencers!
+  
+  # Run any available migration if needed
+  ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+  
+  MagickTitle.options[:root] = Rails.root
+  
+end
+
+Spork.each_run do
+  
+  #Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| load f }
+  
+end

data/test/unit/has_magick_title_test.rb

@@ -0,0 +1,86 @@
+require_relative '../test_helper'
+
+class HasMagickTitleTest < Test::Unit::TestCase
+
+  def setup
+    # nada
+  end
+  
+  should "have has_magick_title in active record's singleton_methods" do
+    assert ActiveRecord::Base.singleton_methods.include?(:has_magick_title)
+  end
+  
+  should "have a model that's called has_magick_title" do
+    assert Post.singleton_methods.include?(:has_magick_title)
+  end
+    
+  context "with a magick_title model" do
+    
+    setup do
+      @post = Post.new(:title => "A posty post")
+    end 
+    
+    should "have proper instance methods" do
+      [:image_title, :image_title=, :has_image_title?, :has_magick_title?, :refresh_magick_title, :magick_title_options ].each do |method|    
+        assert @post.respond_to?(method)
+      end
+    end
+    
+    should "create an image upon save" do
+      assert @post.valid?
+      assert @post.save
+      assert_not_nil @post.image_title
+      path = @post.image_title.full_path
+      assert File.exists?(path), "#{path} should exist"
+    end
+
+    context "an existing post" do
+      
+      setup do
+        @post = Post.create(:title => "Hello McPosty")
+        @path = @post.image_title.full_path
+      end
+         
+      should "do nothing if the attribute is unchanged" do
+        @post.save
+        new_path = @post.image_title.full_path 
+        assert_equal @path, new_path
+      end
+      
+      should "refresh if force option is given" do
+        path = @post.image_title.full_path
+        timestamp = File.new(path).mtime
+        # allow for a time change
+        sleep 1
+        @post.send(:refresh_magick_title, :force => true)        
+        assert timestamp < File.new(path).mtime
+      end
+      
+      should "not refresh if force option is absent" do
+        path = @post.image_title.full_path
+        timestamp = File.new(path).mtime
+        # allow for a time change
+        sleep 1
+        @post.send(:refresh_magick_title)
+        assert_equal timestamp, File.new(path).mtime
+      end
+       
+      should "delete the old image when changed and create a new one" do
+        @post.title = "Another title!"
+        @post.save
+        assert !File.exists?(@path), "#{@path} shouldn't exist"
+        new_path = @post.image_title.full_path
+        assert_not_equal @path, new_path
+        assert File.exists?(new_path), "#{new_path} should exist"
+      end
+
+      should "delete the image with the record" do
+        @post.destroy
+        assert !File.exists?(@path)
+      end
+
+    end
+    
+  end
+    
+end

data/test/unit/image_title_test.rb

@@ -0,0 +1,26 @@
+require_relative '../test_helper'
+
+class ImageTitleTest < Test::Unit::TestCase
+
+  def setup
+    @post = Post.create(:title => "A posty post")
+    @image_title = @post.image_title
+  end
+  
+  should "have proper defaults" do
+    assert_not_nil @post
+    assert_not_nil @image_title
+  end
+  
+  should "have proper instance methods" do
+    [ :url, :full_path ].each do |method|    
+      assert @image_title.respond_to?(method)
+    end
+  end
+  
+  should "have proper protected delete method" do
+    assert !@image_title.respond_to?(:delete_magick_title)
+    assert @image_title.private_methods.include?(:delete_magick_title)
+  end
+  
+end

data/test/unit/style_test.rb

@@ -0,0 +1,30 @@
+require_relative '../test_helper'
+
+class StyleTest < Test::Unit::TestCase
+
+  def setup
+    
+    MagickTitle.style :h1 do
+      font_size   50
+      line_height -10
+    end
+        
+    Post.class_eval do
+      has_magick_title :title, :h1
+    end
+    
+    @post = Post.create(:title => "A posty post")
+    @image_title = @post.image_title
+  end
+  
+  should "have proper defaults" do
+    assert_not_nil @post
+    assert_not_nil @image_title
+  end
+  
+  should "have have style options" do
+    assert_equal 50,  @post.magick_title_options[:font_size]
+    assert_equal -10, @post.magick_title_options[:line_height]    
+  end
+  
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: has_magick_title
+version: !ruby/object:Gem::Version 
+  prerelease: 6
+  version: 0.1.0.rc1
+platform: ruby
+authors: 
+- Spencer Steffen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: magick_title
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0.rc1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.11.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: dummier
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: spork
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.0.rc7
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: spork-testunit
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.5
+  type: :development
+  version_requirements: *id007
+description: Automagically creates an image of your rails model's title using magick_title.
+email: 
+- spencer@citrusme.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- has_magick_title.gemspec
+- lib/dummy_hooks/after_app_generator.rb
+- lib/dummy_hooks/after_migrate.rb
+- lib/dummy_hooks/before_migrate.rb
+- lib/generators/has_magick_title/install_generator.rb
+- lib/generators/templates/add_has_magick_title.rb
+- lib/has_magick_title.rb
+- lib/has_magick_title/image_title.rb
+- lib/has_magick_title/version.rb
+- lib/has_magick_title/view_helper.rb
+- lib/magick_title/extension.rb
+- test/fonts/PermanentMarker.ttf
+- test/test_helper.rb
+- test/unit/has_magick_title_test.rb
+- test/unit/image_title_test.rb
+- test/unit/style_test.rb
+has_rdoc: true
+homepage: https://github.com/citrus/has_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: 1.3.1
+requirements: []
+
+rubyforge_project: has_magick_title
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Automagically creates an image of your rails model's title using magick_title.
+test_files: 
+- test/fonts/PermanentMarker.ttf
+- test/test_helper.rb
+- test/unit/has_magick_title_test.rb
+- test/unit/image_title_test.rb
+- test/unit/style_test.rb