compass-magick 0.1.2 → 0.1.3

data/README.md

@@ -1,7 +1,7 @@
 Compass Magick
 ==============
 
-Dynamic image generation for Compass using ChunkyPNG (no dependency on RMagick).
+Dynamic image generation for Compass using ChunkyPNG/PhantomJS (no dependency on RMagick).
 
 Example
 -------
@@ -22,6 +22,8 @@ Installation is simple via RubyGems. [Compass](http://beta.compass-style.org) an
 
     gem install compass-magick
 
+If you wish to use [PhantomJS](http://www.phantomjs.org/), please follow the [build instructions](http://code.google.com/p/phantomjs/wiki/BuildInstructions).
+
 Usage
 -----
 
@@ -33,12 +35,14 @@ To use Compass Magick within your existing projects, require the plugin from you
 
     require 'magick'
 
+There is a [short tutorial](http://blog.angeloff.name/post/4659977659/compass-magick-tutorial-part-1) available which should guide you through creating a simple themeable button.
+
 APIs
 ----
 
 [List of all available commands](https://github.com/StanAngeloff/compass-magick/blob/master/APIs.md).
 
-RDoc is also [available for the entire project](http://stanangeloff.github.com/compass-magick/doc/frames.html).
+RDoc is also [available for the entire project](http://rubydoc.info/gems/compass-magick/frames).
 
 Contribute
 ----------
@@ -50,8 +54,8 @@ You can help by looking at any of the following areas (ordered by priority):
 - [Optimizing the code](https://github.com/StanAngeloff/compass-magick/blob/master/lib/magick/canvas.rb#L98) as floating point math may not always be needed and too many object copies sucks
 - [Writing tests](https://github.com/StanAngeloff/compass-magick/tree/master/spec) to make sure nothing breaks in new versions
 - [Performing code reviews](https://github.com/StanAngeloff/compass-magick/tree/master/lib) since this is my very first Ruby project and I don't have any experience with the language so there are probably many st**OO**pid things in code
-- [Improving RDoc](http://stanangeloff.github.com/compass-magick/doc/frames.html) because you can never have too much documentation
-- [Adding new plugins](http://stanangeloff.github.com/compass-magick/doc/Compass/Magick/Plugins.html). Compass Magick [looks](https://github.com/StanAngeloff/compass-magick/blob/master/lib/magick.rb#L39) for Ruby files and imports those on startup
+- [Improving RDoc](http://rubydoc.info/gems/compass-magick/frames) because you can never have too much documentation
+- [Adding new plugins](http://rubydoc.info/gems/compass-magick/Compass/Magick/Plugins.html). Compass Magick [looks](https://github.com/StanAngeloff/compass-magick/blob/master/lib/magick.rb#L39) for Ruby files and imports those on startup
 - [Submitting more examples](https://github.com/StanAngeloff/compass-magick/tree/gh-pages) to show off what Compass Magick can do
 - [Opening issues](https://github.com/StanAngeloff/compass-magick/issues) for features you find missing or broken
 - Porting over some of [CamanJS](http://camanjs.com/)' goodness, we all love visual effects
@@ -64,4 +68,4 @@ You can help by looking at any of the following areas (ordered by priority):
 
 ### Copyright
 
-Copyright (c) 2011 Stan Angeloff. See [LICENSE.md](https://github.com/StanAngeloff/compass-magick/blob/master/LICENSE.md) for details.
+> Copyright (c) 2011 Stan Angeloff. See [LICENSE.md](https://github.com/StanAngeloff/compass-magick/blob/master/LICENSE.md) for details.

data/extras/magick.js

@@ -0,0 +1,57 @@
+#!/usr/bin/env phantomjs
+if (phantom.state.length === 0) {
+  var width   = parseInt(phantom.args[0], 10),
+      height  = parseInt(phantom.args[1], 10),
+      padding = Math.max(width, height),
+      head, body, i, styles, j, length, instruction;
+  if (isNaN(width) || isNaN(height) || phantom.args.length < 4) {
+    console.error('Usage: magick.js width height styles [styles […]] filename');
+    phantom.exit();
+  } else {
+    head = []; body = [];
+    for (i = 2; i < phantom.args.length - 1; i ++) {
+      styles = phantom.args[i].split(';');
+      for (j = 0, length = styles.length; j < length; j ++) {
+        instruction = styles[j].replace(/^\s+|\s+$/g, '');
+        if (instruction.indexOf(':') > 0) {
+          styles.push('-webkit-' + instruction);
+        }
+      }
+      head.push('#element-' + i + ' { ' +
+        'width:  ' + width  + 'px; ' +
+        'height: ' + height + 'px; ' +
+        'box-sizing: border-box; ' +
+        '-webkit-box-sizing: border-box; ' +
+        styles.join('; ') + '; ' +
+      '}');
+      body.push('<div id="element-' + i + '"></div>');
+    }
+    try {
+      phantom.state = 1;
+      phantom.viewportSize = {
+        width:  width  + padding * 2,
+        height: height + padding * 2
+      };
+      phantom.content =
+        '<html>' +
+          '<head>' +
+          '<style>' +
+            head.join('\n') +
+          '</style>' +
+          '</head>' +
+          '<body style="background: transparent; margin: ' + padding + 'px ' + padding + 'px; padding: 0;">' +
+            body.join('\n') +
+          '</body>' +
+        '</html>';
+    } catch (e) {
+      phantom.exit();
+      throw e;
+    }
+  }
+} else {
+  try {
+    phantom.render(phantom.args[phantom.args.length - 1]);
+  } finally {
+    phantom.exit();
+  }
+}

data/lib/magick.rb

@@ -32,7 +32,7 @@ module Compass::Magick
   # The current version of Compass Magick. This value is updated manually on
   # release. If you are using a Git clone, the version will always end with
   # '.git'.
-  VERSION = '0.1.2.git'
+  VERSION = '0.1.3.git'
 
   # The locations where plug-ins are located. These paths are scanned for
   # *.rb files and loaded in order.
@@ -42,6 +42,9 @@ module Compass::Magick
     File.join(Dir.getwd,              'plugins')
   ]
 
+  # The location of the `extras/` directory.
+  EXTRAS_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..', 'extras'))
+
   # Default exception class for Compass Magick
   class Exception < ::StandardError; end
 
@@ -62,6 +65,7 @@ module Compass::Magick
 end
 
 require 'magick/utils'
+require 'magick/configuration'
 require 'magick/scriptable'
 require 'magick/command'
 require 'magick/effect'
@@ -77,3 +81,7 @@ Compass::Frameworks.register('magick',
   :stylesheets_directory => File.join(File.dirname(__FILE__), 'stylesheets'),
   :templates_directory   => File.join(File.dirname(__FILE__), 'templates')
 )
+
+# Extend Compass configuration with new properties (defined by Compass Magick
+# and plugins).
+Compass::Configuration::Data.send(:include, Compass::Magick::Configuration)

data/lib/magick/configuration.rb

@@ -0,0 +1,41 @@
+require 'shellwords'
+
+module Compass::Magick
+  # Configuration methods to allow plugins to register new configurable
+  # properties.
+  module Configuration
+    extend Compass::Configuration::Inheritance::ClassMethods
+    extend self
+
+    # Registers a new property in `config.rb`.
+    #
+    # If you use this method, you should also define two additional methods:
+    #
+    # - comment_for_$name - emits a comment against the properly into the
+    #   configuration file when serialized
+    # - default_$name - provides a default value for the property when one
+    #   isn't specified in the configuration file
+    #
+    # @param [Symbol] name The name of the property.
+    def add_property(name)
+      Compass::Configuration::ATTRIBUTES.push(name)
+      inherited_accessor(name)
+    end
+
+    # Converts a Cygwin Unix path to a Windows path, e.g.:
+    #
+    #     /cygdrive/d/path/to/file
+    #       ==>
+    #     D:/path/to/file
+    #
+    # @param [String] path The Unix path to convert.
+    # @return [String] The Windows path.
+    def cygwin_path(path)
+      if RUBY_PLATFORM.include?('cygwin') && path.index('/') == 0
+        IO.popen("cygpath -m #{path.include?(':') ? '-p' : ''} #{path.shellescape}").readline.chomp.gsub(/;/, '\\;')
+      else
+        path
+      end
+    end
+  end
+end

data/lib/magick/functions/operations.rb

@@ -85,7 +85,7 @@ module Compass::Magick
                 ChunkyPNG::Color.r(canvas_pixel),
                 ChunkyPNG::Color.g(canvas_pixel),
                 ChunkyPNG::Color.b(canvas_pixel),
-                ChunkyPNG::Color.a(canvas_pixel) * (mask_alpha / 255.0)
+                (ChunkyPNG::Color.a(canvas_pixel) * (mask_alpha / 255.0)).to_i
               ))
             end
           end

data/lib/magick/shapes.rb

@@ -45,7 +45,7 @@ module Compass::Magick
             else
               if sqdist < rpf2
                 fact = (((center - Math.sqrt(sqdist)) * 2.0 / feather) * 0.5 + 0.5)
-                mask.set_pixel(x, y, ChunkyPNG::Color.rgba(255, 255, 255, 255 * [0, [fact, 1].min].max))
+                mask.set_pixel(x, y, ChunkyPNG::Color.rgba(255, 255, 255, (255 * [0, [fact, 1].min].max).to_i))
               end
             end
           end
@@ -75,13 +75,13 @@ module Compass::Magick
                 if sqdist < romf2
                   if sqdist < ripf2
                     fact = (((Math.sqrt(sqdist) - inrad) * 2 / feather) * 0.5 + 0.5)
-                    mask.set_pixel(x, y, ChunkyPNG::Color.rgba(255, 255, 255, 255 * [0, [fact, 1].min].max))
+                    mask.set_pixel(x, y, ChunkyPNG::Color.rgba(255, 255, 255, (255 * [0, [fact, 1].min].max).to_i))
                   else
                     mask.set_pixel(x, y, ChunkyPNG::Color::WHITE)
                   end
                 else
                   fact = (((center - Math.sqrt(sqdist)) * 2 / feather) * 0.5 + 0.5)
-                  mask.set_pixel(x, y, ChunkyPNG::Color.rgba(255, 255, 255, 255 * [0, [fact, 1].min].max))
+                  mask.set_pixel(x, y, ChunkyPNG::Color.rgba(255, 255, 255, (255 * [0, [fact, 1].min].max).to_i))
                 end
               end
             end

data/lib/magick/utils.rb

@@ -35,7 +35,7 @@ module Compass::Magick
     # @param [Sass::Script::Color] color The source color in Sass' format.
     # @return [ChunkyPNG::Color] The source color in ChunkyPNG's format.
     def to_chunky_color(color)
-      ChunkyPNG::Color.rgba(color.red, color.green, color.blue, color.alpha * 255)
+      ChunkyPNG::Color.rgba(color.red, color.green, color.blue, (color.alpha * 255).to_i)
     end
 
     # Converts a fill type (solid color or gradient) to a {Canvas} object.

data/lib/plugins/phantom.rb

@@ -0,0 +1,132 @@
+module Compass::Magick
+  module Configuration
+    # Registers a new property in config.rb `phantom_executable` which allows
+    # Users to configure the location of the PhantomJS binary.
+    #
+    # You would usually have `phantomjs` on $PATH, but in cases where you have
+    # installed it to another directory, you can specify the full path using
+    # this property.
+    add_property :phantom_executable
+
+    # Registers a new property in config.rb `phantom_script` which allows
+    # Users to configure the location of the PhantomJS rendering script.
+    #
+    # This is very useful on Cygwin installations where Cygwin paths don't
+    # mix well with a Windows build of PhantomJS.
+    add_property :phantom_script
+
+    # Emits the comment for the `phantom_executable` property into the
+    # configuration file when serialized -- makes it easier to understand for
+    # new Users.
+    #
+    # @return [String] The comment for the `phantom_executable` property.
+    def comment_for_phantom_executable
+      "# Path to the PhantomJS binary\n"
+    end
+
+    # Emits the comment for the `phantom_script` property into the
+    # configuration file when serialized -- makes it easier to understand for
+    # new Users.
+    #
+    # @return [String] The comment for the `phantom_script` property.
+    def comment_for_phantom_script
+      "# Path to magick.js used to render a web page (using PhantomJS, a headless WebKit)\n"
+    end
+
+    # Provides the default value for `phantom_executable` when one isn't
+    # specified in the configuration file.
+    #
+    # @return [String] The default path to the PhantomJS binary.
+    def default_phantom_executable
+      ENV['PHANTOM_PATH'] || 'phantomjs'
+    end
+
+    # Provides the default value for `phantom_script` when one isn't
+    # specified in the configuration file.
+    #
+    # @return [String] The default path to the magick.js script used to
+    #   render a web page.
+    def default_phantom_script
+      cygwin_path(ENV['PHANTOM_SCRIPT'] || File.join(EXTRAS_PATH, 'magick.js'))
+    end
+  end
+
+  module Plugins
+    # Creates a new {Canvas} with the given width and height and renders all
+    # styles using the PhantomJS headless Webkit. The resulting image is
+    # cropped by removing all transparent pixels.
+    #
+    # The PhantomJS viewport will be set to `width` / `height` with
+    # padding: max(`width`, `height`). If you apply drop shadows or outlines,
+    # the returned image will be larger than the specified size to accommodate
+    # the overflowing content.
+    #
+    # @see {Compass::Magick::Configuration}
+    # @overload magick_phantom(width, height, styles)
+    #   @param [Sass::Script::Number] width The (desired) width of the canvas.
+    #   @param [Sass::Script::Number] height The (desired) height of the
+    #     canvas.
+    #   @param [{String => Sass::Script::String}] styles The CSS styles to
+    #     render in PhantomJS where the hash key is the CSS property name and
+    #     the hash value is the CSS property value.
+    # @overload magick_phantom(width, height, *styles)
+    #   @param [Sass::Script::Number] width The (desired) width of the canvas.
+    #   @param [Sass::Script::Number] height The (desired) height of the
+    #     canvas.
+    #   @param [[String]] styles A list of CSS styles to render in PhantomJS.
+    # @return {Canvas} A new Canvas instance cropped of all transparent
+    #   pixels.
+    def magick_phantom(width, height, *args)
+      Compass::Magick::Utils.assert_type 'width',  width,  Sass::Script::Number
+      Compass::Magick::Utils.assert_type 'height', height, Sass::Script::Number
+      elements = []
+      args.each do |styles|
+        Compass::Magick::Utils.assert_one_of 'magick-phantom(..)', styles, Sass::Script::String, Hash
+        instructions = []
+        if styles.kind_of?(Sass::Script::String)
+          instructions.push(styles.value)
+        else
+          styles.each do |key, value|
+            instructions.push("#{key.gsub('_', '-')}: #{value.kind_of?(Sass::Script::String) ? value.value : value.to_s}")
+          end
+        end
+        elements.push(instructions.join('; '))
+      end
+      basename = "~magick-phantom-#{ rand(36**8).to_s(36) }.png"
+      filename = File.join(Compass.configuration.images_path, basename)
+      command  = [Compass.configuration.phantom_executable, Compass.configuration.phantom_script]
+      command  = command.concat([width.to_s, height.to_s])
+      command  = command.concat(elements)
+      command  = command.concat([Compass::Magick::Configuration.cygwin_path(filename)])
+      begin
+        system(command.shelljoin)
+        canvas = Canvas.new(Sass::Script::String.new(basename))
+        min_top    = canvas.height - 1
+        max_right  = 0
+        max_bottom = 0
+        min_left   = canvas.width - 1
+        for y in 0...canvas.height
+          for x in 0...canvas.width
+            if ! ChunkyPNG::Color.fully_transparent?(canvas.get_pixel(x, y))
+              min_top    = y if y < min_top
+              max_right  = x if x > max_right
+              max_bottom = y if y > max_bottom
+              min_left   = x if x < min_left
+            end
+          end
+        end
+        if min_left < max_right && min_top < max_bottom
+          canvas.crop(min_left, min_top, max_right - min_left + 1, max_bottom - min_top + 1)
+        else
+          puts '(Compass:Magick) Phantom image rendering failed. Please make sure you have at least one drawing instruction in your styles:'
+          puts "$ #{command.shelljoin}"
+          canvas
+        end
+      ensure
+        File.unlink(filename) if File.exists?(filename)
+      end
+    end
+
+    Sass::Script::Functions.declare :magick_phantom, [:width, :height], :var_args => true, :var_kwargs => true
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: compass-magick
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Stan Angeloff
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-16 00:00:00 Z
+date: 2011-04-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: compass
@@ -80,6 +80,7 @@ files:
 - LICENSE.md
 - lib/magick/canvas.rb
 - lib/magick/command.rb
+- lib/magick/configuration.rb
 - lib/magick/effect.rb
 - lib/magick/functions/canvas.rb
 - lib/magick/functions/drawing.rb
@@ -98,7 +99,9 @@ files:
 - lib/magick.rb
 - lib/plugins/corners.rb
 - lib/plugins/pattern.rb
+- lib/plugins/phantom.rb
 - lib/stylesheets/_magick.sass
+- extras/magick.js
 - spec/canvas_spec.rb
 - spec/helpers.rb
 - spec/types/gradients_spec.rb
@@ -135,7 +138,7 @@ rubyforge_project:
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: Dynamic image generation for Compass using ChunkyPNG.
+summary: Dynamic image generation for Compass using ChunkyPNG/PhantomJS.
 test_files: 
 - spec/canvas_spec.rb
 - spec/helpers.rb