magic_door 0.1.0b

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Daniel Mircea, OkapiStudio
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,75 @@
+= MagicDoor Generator
+
+Generates custom button images with RMagick using the famous {sliding doors css tehnique}[http://www.alistapart.com/articles/slidingdoors].
+
+
+== A brief introduction
+
+While it can be argued that this functionality is being preceded by CSS 3, this code provides a happy crossbrowser experience, backed by the ability of using copyrighted fonts.
+
+The script works by splitting a large wide image into two narrow ones that accomodate the length of a provided text. The location where the split ocurrs can be specified as an optional parameter.
+
+
+== Generating buttons
+
+Bellow you'll find a simple example of creating an image button:
+
+  options = {
+    :text       => "Please click me"
+    :image      => "wide-button-template.png"
+    :file_name  => "click-me.png",
+    :css        => "color: #333; font-size: 25"
+  }
+
+  file = MagicDoor.new(options)
+  file.save
+
+You may set defaults in order to make subsequent calls simpler:
+
+  MagicDoor.defaults.merge!({
+    :source_path      => "/project/path/buttons",
+    :destination_path => "/project/path/buttons/cache",
+    :split_at         => 11,
+    :css              => "padding: 10;
+                          font-weight: bold;
+                          font-size: 14;
+                          color: #fff; text-align: center;
+                          text-shadow: #cecefe 0 1;
+                          font: '/project/path/fonts/MyriadPro-Semibold.otf"
+  })
+
+
+== Limitations
+
+All CSS sizes are calculated in pixels, so you should not add any measurement units after the numbers.
+
+The padding property does not affect the top and bottom region.
+
+Parsing the CSS and mapping it to RMagick is somewhat tendious, as such there are only a few css properties supported. Please consult the docs for a complete list.
+
+
+== Command Line
+
+You can run MagicDoor from the command line:
+
+  $ magic-door -t "hello world" -i "/home/daniel/Desktop/button.png" -f "/home/daniel/hello.png"
+
+
+== Source code
+
+The source code is hosted on Github: http://github.com/viseztrance/magic_door
+
+To get MagicDoor from source:
+
+  git clone git@github.com:viseztrance/magic_door.git
+
+
+== Acknowledgements
+
+I would like to thank {OkapiStudio}[http://okapistudio.com] - my employer for allowing me to share this code.
+
+
+== License
+
+This package is licensed under the MIT license and/or the Creative
+Commons Attribution-ShareAlike.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/rdoctask'
+
+
+spec = Gem::Specification.load(File.expand_path("magic_door.gemspec", File.dirname(__FILE__)))
+
+# Create the documentation.
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.include "README.rdoc", "lib/**/*.rb"
+  rdoc.options = spec.rdoc_options
+end
+
+desc "Push new release to rubyforge and git tag"
+task :push do
+  sh "git push"
+  puts "Tagging version #{spec.version} .."
+  sh "git tag v#{spec.version}"
+  sh "git push --tag"
+  puts "Building and pushing gem .."
+  sh "gem build #{spec.name}.gemspec"
+  sh "gem push #{spec.name}-#{spec.version}.gem"
+end
+
+desc "Install #{spec.name} locally"
+task :install do
+  sh "gem build #{spec.name}.gemspec"
+  sh "gem install #{spec.name}-#{spec.version}.gem"
+end

data/bin/magic-door

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "magic_door"
+
+options = {}
+
+ARGV.options do |opt|
+  script_name = File.basename($0)
+
+  opt.set_summary_indent("  ")
+  opt.banner = "Usage: #{script_name} [options]"
+  opt.define_head "Generates custom button images with RMagick using the famous sliding doors css tehnique."
+  opt.separator ""
+
+  opt.on("-t", "--text=val", String,
+         "Text shown on the button, eg. \"click me\"") { |options[:text]| }
+  opt.on("-i", "--image=val", String,
+         "Path to the existing image that will be used as a template, eg. \"/home/me/rails/public/images/button.png\"") { |options[:image]| }
+  opt.on("-f", "--file=val", String,
+         "Path of the saved image, eg. \"/home/me/rails/public/images/cache/click-me.png\"") { |options[:file_name]| }
+  opt.on("-c", "--css=val", String,
+         "Css expression, eg. \"font-weight: bold; font-size: 25\"") { |options[:css]| }
+  opt.on("-s", "--split=val", String,
+         "The location where the template image be split in two.") { |options[:split_at]| }
+
+  opt.separator ""
+
+  opt.on_tail("-h", "--help", "Show this help message.") { puts opt; exit }
+  opt.on_tail("-v", "--version", "Show version") { puts script_name + ' ' + MagicDoor::VERSION; exit }
+
+  opt.parse!
+end
+
+if options[:text].nil? || options[:image].nil? || options[:file_name].nil?
+  puts %q|Insufficient arguments.
+The "text" (-t), "image" (-i) and "file" (-f) options are required. -h for additional information.|
+else
+  saved_file = MagicDoor.new(options).save
+  puts "Wrote #{saved_file.inspect}."
+end

data/lib/magic_door.rb

@@ -0,0 +1,220 @@
+#
+# = magic_door.rb - MagicDoor generator
+#
+# Author:: Daniel Mircea daniel@viseztrance.com
+# Copyright:: Copyright (c) 2010 Daniel Mircea, OkapiStudio
+# License:: MIT and/or Creative Commons Attribution-ShareAlike
+
+require "RMagick"
+require "fileutils"
+
+class MagicDoor
+
+  VERSION = Gem::Specification.load(File.expand_path("../magic_door.gemspec", File.dirname(__FILE__))).version.to_s
+
+  module CssMethods #:nodoc:
+
+    def set_properties(css)
+
+      css.each do |args|
+        attribute = MagicDoor::CSS_ALIASES[:attributes][args.first] || args.first
+        value = proc {
+          v = MagicDoor::CSS_ALIASES[:values][args.last] || args.last
+          Float(v) rescue v
+        }.call
+        self.send("#{attribute}=", value)
+      end
+
+    end
+
+  end
+
+  CSS_ALIASES = {
+
+    :attributes => {
+      "color"       => "fill",
+      "font-weight" => "font_weight",
+      "font-family" => "font_family",
+      "font-size"   => "pointsize",
+      "text-align"  => "gravity",
+    },
+
+    :values => {
+      "bold"   => Magick::BoldWeight,
+      "center" => Magick::CenterGravity,
+      "left"   => Magick::WestGravity,
+      "right"  => Magick::EastGravity
+    }
+
+  }
+
+  attr_reader           :css,
+                        :image
+
+
+  attr_accessor         :text,
+                        :split_at,
+                        :source_path,
+                        :destination_path,
+                        :file_name
+
+  attr_accessor         :canvas #:nodoc:
+
+  @@defaults = {
+    :css              => "text-align: center; padding: 10; color: #000",
+    :split_at         => 30,
+    :image            => "button.png",
+    :source_path      => "",
+    :destination_path => "",
+    :text             => "Submit",
+    :file_name        => "result.png"
+  }
+
+  class << self
+
+    # Sets +defaults+ for new object instances.
+    def defaults=(options)
+      @@defaults = options
+    end
+
+    # Returns defined defaults
+    def defaults
+      @@defaults
+    end
+
+  end
+
+  # Instantiate a new object.
+  # Missing options fallback to +defaults+.
+  # ==== Options:
+  # [*text*] Text that will be displayed inside the button.
+  # [*split_at*] Location where the image is being split.
+  # [*source_path*] Prefix for +image+ location.
+  # [*destination_path*] Prefix for +file_name+ location.
+  # [*file_name*] The name of the file being saved.
+  def initialize(options = {})
+    self.css = self.class.defaults[:css]
+    self.css = options[:css] if options[:css]
+    %w(source_path destination_path split_at image text file_name).each do |name|
+      n = name.to_sym
+      self.send("#{n}=", options[n] || self.class.defaults[n])
+    end
+  end
+
+  # Creates the image file.
+  # ==== Returns
+  # Path of the saved file.
+  # ==== Options
+  # [*as*] Alternate way of setting the name of the file being saved. Fallsback to +file_name+.
+  def save(options = {})
+    compose_button
+    draw
+    write_file(options[:as] || file_name)
+  end
+
+  # Sets the template image.
+  #
+  # Will fail if the image does not exist.
+  def image=(name)
+    @image = Magick::Image.read(File.join(source_path, name)).first
+  end
+
+  # Evaluates CSS expressions.
+  #
+  # Gracefuly merges the CSS defined in +defaults+.
+  #
+  # Sizes are being calculated in pixels. Don't specify any measuring units at all.
+  # ==== Available expressions:
+  # * color
+  # * font-weight
+  # * font-family
+  # * font-size
+  # * text-align
+  # * padding
+  # * width
+  # * height
+  # * left
+  # * right
+  def css=(expressions)
+
+    values = { :container => [], :shadow => [], :text => [] }
+
+    expressions.to_s.delete("\n").split(";").each do |expression|
+
+      args = expression.split(":").each { |arg| arg.strip! }
+
+      if %w(width height padding left right).include?(args.first)
+        values[:container] << args
+      elsif args.first == "text-shadow"
+        values[:shadow] << args
+      else
+        values[:text] << args
+      end
+
+    end
+
+    @css ||= {}
+    @css.merge!(values) { |key, old, new|
+      keys = new.collect { |e| e.first }
+      old.each { |e| new << e unless keys.index(e.first) }
+      new
+    }
+
+  end
+
+  def canvas #:nodoc:
+    @canvas ||= proc {
+      padding = (get_css_property(css[:container], "padding") || text_width).to_i
+      width   = (get_css_property(css[:container], "width") || text_width).to_i + padding
+      height  = (get_css_property(css[:container], "height") || image.rows).to_i
+      Magick::Image.new(width, height) { self.background_color = "none" }
+    }.call
+  end
+
+  private
+
+  def draw
+    drawing = Magick::Draw.new
+    drawing.extend(CssMethods)
+    drawing.set_properties(css[:text])
+    margin_left = (get_css_property(css[:container], "left")).to_i
+    margin_right = (get_css_property(css[:container], "right")).to_i
+    margin = margin_left - margin_right
+    if !css[:shadow].empty?
+      args         = css[:shadow].first.last.split
+      drawing.fill = args.first
+      drawing.annotate(self.canvas, 0, 0, margin + args[1].to_i, args[2].to_i, text)
+      drawing.fill = get_css_property(css[:text], "color")
+    end
+    drawing.annotate(self.canvas, 0, 0, margin, 0, text)
+  end
+
+  def get_css_property(stack, key)
+    stack.reject { |c| c.first != key }.flatten.last
+  end
+
+  def compose_button
+    main_image = image.crop(Magick::EastGravity, (canvas.columns - split_at), canvas.rows)
+    left_image = image.crop(Magick::WestGravity, split_at, canvas.rows)
+    self.canvas.composite!(main_image, left_image.columns, 0, Magick::OverCompositeOp)
+    self.canvas.composite!(left_image, Magick::WestGravity, Magick::OverCompositeOp)
+  end
+
+  def write_file(name)
+    FileUtils.mkdir_p destination_path unless destination_path.empty?
+    save_path = File.join(destination_path, name)
+    canvas.write(save_path)
+    save_path
+  end
+
+  def text_width(offset = 6)
+    temporary_canvas = Magick::Image.new(1000, 150)
+    drawing = Magick::Draw.new
+    drawing.extend(CssMethods)
+    drawing.set_properties(css[:text])
+
+    return (drawing.get_type_metrics(temporary_canvas, text)["width"] + offset)
+
+  end
+
+end

data/magic_door.gemspec

@@ -0,0 +1,20 @@
+spec = Gem::Specification.new do |spec|
+  spec.name = "magic_door"
+  spec.version = "0.1.0b"
+  spec.summary = "MagicDoor generator"
+  spec.description = <<-EOF
+Generates custom button images with RMagick using the famous sliding doors css tehnique.
+EOF
+
+  spec.authors << "Daniel Mircea"
+  spec.email = "daniel@viseztrance.com"
+  spec.homepage = "http://github.com/viseztrance/magic_door"
+
+  spec.files = Dir["{bin,lib,docs}/**/*"] + ["README.rdoc", "LICENSE", "Rakefile", "magic_door.gemspec"]
+  spec.executables = "magic-door"
+
+  spec.has_rdoc = true
+  spec.rdoc_options << "--main" << "README.rdoc" << "--title" <<  "MagicDoor generator" << "--line-numbers"
+                       "--webcvs" << "http://github.com/viseztrance/magic_door"
+  spec.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: magic_door
+version: !ruby/object:Gem::Version 
+  hash: 3247241
+  prerelease: true
+  segments: 
+  - 0
+  - 1
+  - 0b
+  version: 0.1.0b
+platform: ruby
+authors: 
+- Daniel Mircea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-19 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |
+  Generates custom button images with RMagick using the famous sliding doors css tehnique.
+
+email: daniel@viseztrance.com
+executables: 
+- magic-door
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- bin/magic-door
+- lib/magic_door.rb
+- README.rdoc
+- LICENSE
+- Rakefile
+- magic_door.gemspec
+has_rdoc: true
+homepage: http://github.com/viseztrance/magic_door
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- MagicDoor generator
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: MagicDoor generator
+test_files: []
+