compass-canvas 0.0.4 → 0.0.5

data/README.md

@@ -73,6 +73,12 @@ For a complete reference on Cairo methods, visit [Pycairo documentation][pycairo
   [cairo-tutorial]: http://zetcode.com/tutorials/cairographicstutorial/
   [pycairo]:        http://cairographics.org/documentation/pycairo/3/reference/context.html#class-context
 
+Similar Projects
+----------------
+
+[compass-magick](https://github.com/StanAngeloff/compass-magick) is a pure Ruby dynamic image generation for Compass using ChunkyPNG/PhantomJS (no dependency on RMagick despite the name).
+If you are looking for a project to generate image gradients or small & simple buttons, go check it out.
+
 ### Copyright
 
 > Copyright (c) 2011 Stan Angeloff. See [LICENSE.md](https://github.com/StanAngeloff/compass-canvas/blob/master/LICENSE.md) for details.

data/lib/canvas.rb

@@ -7,7 +7,7 @@ module Compass::Canvas
   # The project and Gem version. When building a Gem file for release, the
   # version is stripped to X.Y.Z. If you are using a Git cloned-repository,
   # the version will end in +.git+.
-  VERSION = '0.0.4.git'
+  VERSION = '0.0.5.git'
 
   # The default backend for drawing.
   BACKEND = 'cairo'
@@ -20,6 +20,19 @@ module Compass::Canvas
     File.expand_path(File.join(File.dirname(__FILE__), '..', directory))
   end
 
+  # Helper function to normalize a CSS path to a filesystem path.
+  #
+  # @param [String] file A CSS file, usually with url(..) and optionally a cache buster.
+  # @return [String] The absolute filesystem path.
+  def self.absolute_path_to(file)
+    if file.include?('url(')
+      file = File.join(Compass.configuration.css_path, file.gsub(/^url\(['"]?|["']?\)$/, ''))
+    else
+      file = File.join(Compass.configuration.images_path, file)
+    end
+    file.split('?').shift()
+  end
+
   # Locations where plug-ins are installed. These paths are scanned for *.rb files
   # and loaded in order.
   PLUGINS_PATH = [

data/lib/canvas/actions.rb

@@ -1,39 +1,40 @@
 module Compass::Canvas
   # This module contains all actions a backend must implement.
   module Actions
-    ANTIALIAS    = :antialias
-    ARC          = :arc
-    ARC_REVERSE  = :arc_reverse
-    BRUSH        = :brush
-    CLIP         = :clip
-    CLOSE        = :close
-    CURVE        = :curve
-    DASH_PATTERN = :dash_pattern
-    FILL         = :fill
-    FILL_RULE    = :fill_rule
-    GROUP        = :group
-    LINE         = :line
-    LINE_CAP     = :line_cap
-    LINE_JOIN    = :line_join
-    LINE_WIDTH   = :line_width
-    MASK         = :mask
-    MITER_LIMIT  = :miter_limit
-    MOVE         = :move
-    PAINT        = :paint
-    POP          = :pop
-    PUSH         = :push
-    RESET        = :reset
-    RESTORE      = :restore
-    RETRIEVE     = :retrieve
-    ROTATE       = :rotate
-    SAVE         = :save
-    SCALE        = :scale
-    SLOW_BLUR    = :slow_blur
-    STORE        = :store
-    STROKE       = :stroke
-    TOLERANCE    = :tolerance
-    TRANSFORM    = :transform
-    TRANSLATE    = :translate
-    UNCLIP       = :unclip
+    ANTIALIAS       = :antialias
+    ARC             = :arc
+    ARC_REVERSE     = :arc_reverse
+    BRUSH           = :brush
+    CLIP            = :clip
+    CLOSE           = :close
+    CURVE           = :curve
+    DASH_PATTERN    = :dash_pattern
+    FILL            = :fill
+    FILL_RULE       = :fill_rule
+    GROUP           = :group
+    LINE            = :line
+    LINE_CAP        = :line_cap
+    LINE_JOIN       = :line_join
+    LINE_WIDTH      = :line_width
+    MASK            = :mask
+    MITER_LIMIT     = :miter_limit
+    MOVE            = :move
+    PAINT           = :paint
+    POP             = :pop
+    PUSH            = :push
+    QUADRATIC_CURVE = :quadratic_curve
+    RESET           = :reset
+    RESTORE         = :restore
+    RETRIEVE        = :retrieve
+    ROTATE          = :rotate
+    SAVE            = :save
+    SCALE           = :scale
+    SLOW_BLUR       = :slow_blur
+    STORE           = :store
+    STROKE          = :stroke
+    TOLERANCE       = :tolerance
+    TRANSFORM       = :transform
+    TRANSLATE       = :translate
+    UNCLIP          = :unclip
   end
 end

data/lib/canvas/backend.rb

@@ -6,6 +6,7 @@ module Compass::Canvas::Backend
   #
   # Each implementation must respond to four methods:
   # - {Compass::Canvas::Backend::Base::load_dependencies} - initializes the backend by loading third-party dependencies
+  # - {Compass::Canvas::Backend::Base::read_canvas} - reads a canvas from a file
   # - {Compass::Canvas::Backend::Base::begin_canvas} - initialization code before the canvas is drawn
   # - {Compass::Canvas::Backend::Base::execute_one} - executes a single action on the canvas
   # - {Compass::Canvas::Backend::Base::to_blob} - clean up code, must return a
@@ -35,20 +36,15 @@ module Compass::Canvas::Backend
       load_dependencies
       if args[0].is_a?(String)
         file = args.shift
-        unless args[1].is_a?(Fixnum)
-          if file.include?('url(')
-            file = File.join(Compass.configuration.css_path, file.gsub(/^url\(['"]?|["']?\)$/, '').split('?').shift())
-          else
-            file = File.join(Compass.configuration.images_path, file.split('?').shift())
-          end
-        end
+        file = Compass::Canvas.absolute_path_to(file) unless args[0].is_a?(Fixnum)
         @file = file
       end
       if args[0].is_a?(Fixnum)
         @width  = args.shift
         @height = args.shift
       end
-      @actions = args
+      @actions  = args
+      @executed = false
     end
 
     # Abstract method.
@@ -60,6 +56,15 @@ module Compass::Canvas::Backend
       raise Compass::Canvas::Exception.new("(#{self.class}) Class must implement '#{this_method}'.")
     end
 
+    # Abstract method.
+    #
+    # Reads a canvas from a file
+    #
+    # @raise [Compass::Canvas::Exception] Backend implementation must override this method.
+    def read_canvas
+      raise Compass::Canvas::Exception.new("(#{self.class}) Class must implement '#{this_method}'.")
+    end
+
     # Abstract method.
     #
     # Initialization code before the canvas is drawn.
@@ -87,10 +92,32 @@ module Compass::Canvas::Backend
       raise Compass::Canvas::Exception.new("(#{self.class}) Class must implement '#{this_method}'.")
     end
 
+    # Reads a property of the backend.
+    #
+    # This can be used to provide custom information about a backend, such as
+    # width, height, the current point's position, etc.
+    #
+    # @param [String] name The property name.
+    # @return [Object] The property value, or nil if it doesn't exist.
+    def property(name)
+      case name
+      when :width;  return @width
+      when :height; return @height
+      else return nil
+      end
+    end
+
     # Creates an empty canvas and executes all stored actions.
     def execute
-      begin_canvas
-      execute_actions
+      return self if @executed
+      if @width && @height
+        begin_canvas
+        execute_actions
+      else
+        read_canvas
+      end
+      @executed = true
+      self
     end
 
     # Returns the canvas as a Base64 encoded Data URI or as a file on disk
@@ -130,7 +157,6 @@ module Compass::Canvas::Backend
         end
         execute_one(action, *args)
       end
-      self
     end
 
     private

data/lib/canvas/backend/cairo.rb

@@ -25,6 +25,30 @@ module Compass::Canvas::Backend
       end
     end
 
+    # Reads a property of the Cairo backend.
+    #
+    # This can be used to obtain information about the width/height of the
+    # surface as well as the current point's X/Y coordinates.
+    #
+    # @param [String] name The property name.
+    # @return [Object] The property value, or nil if it doesn't exist.
+    def property(name)
+      execute
+      case name
+      when :width;  return @surface.width
+      when :height; return @surface.height
+      when :x;      return @context.current_point[0]
+      when :y;      return @context.current_point[1]
+      else return nil
+      end
+    end
+
+    # Creates a new +ImageSurface+ from a file
+    def read_canvas
+      @surface = ::Cairo::ImageSurface.from_png(@file)
+      bind_context
+    end
+
     # Creates a new +ImageSurface+ and binds a new context to it.
     def begin_canvas
       if @width && @height
@@ -32,9 +56,7 @@ module Compass::Canvas::Backend
       else
         @surface = ::Cairo::ImageSurface.from_png(@file)
       end
-      @context = ::Cairo::Context.new(@surface)
-      @context.set_line_width(1)
-      @sources = []
+      bind_context
     end
 
     # Executes a single action on the context bound to the surface.
@@ -46,6 +68,14 @@ module Compass::Canvas::Backend
         @context.line_to(*args)
       when Compass::Canvas::Actions::CURVE
         @context.curve_to(*args)
+      when Compass::Canvas::Actions::QUADRATIC_CURVE
+        x1, y1, x2, y2 = args
+        x, y = @context.current_point
+        @context.curve_to(
+          x  + 2.0 / 3.0 * (x1 - x),  y  + 2.0 / 3.0 * (y1 - y),
+          x2 + 2.0 / 3.0 * (x1 - x2), y2 + 2.0 / 3.0 * (y1 - y2),
+          x2, y2
+        )
       when Compass::Canvas::Actions::ARC
         @context.arc(*args)
       when Compass::Canvas::Actions::ARC_REVERSE
@@ -117,8 +147,8 @@ module Compass::Canvas::Backend
             pattern.set_extend(constant('EXTEND', args))
             @context.mask(pattern)
           else
-            x = args.shift if args.length
-            y = args.shift if args.length
+            x = args.shift if args.length > 0
+            y = args.shift if args.length > 0
             @context.mask(surface, x || 0, y || 0)
           end
         elsif type == Compass::Canvas::Actions::RETRIEVE
@@ -142,7 +172,7 @@ module Compass::Canvas::Backend
           canvas = args.shift
           if canvas.is_a?(Compass::Canvas::Backend::Cairo)
             pattern = ::Cairo::SurfacePattern.new(canvas.execute.surface)
-            pattern.set_extend(constant('EXTEND', args)) if args.length
+            pattern.set_extend(constant('EXTEND', args)) if args.length > 0
             @context.set_source(pattern)
           else
             raise Compass::Canvas::Exception.new("(#{self.class}.#{action}) Unsupported canvas, Cairo can only paint with Cairo: #{canvas.inspect}")
@@ -169,6 +199,12 @@ module Compass::Canvas::Backend
 
     private
 
+    def bind_context
+      @context = ::Cairo::Context.new(@surface)
+      @context.set_line_width(1)
+      @sources = []
+    end
+
     def constant(name, *args)
       ::Cairo::const_get("#{ name.upcase }_#{ args.join('_').gsub('-', '_').upcase }")
     end

data/lib/canvas/backend/interface/path.rb

@@ -16,6 +16,11 @@ module Compass::Canvas::Backend::Interface
       [x1.value, y1.value, x2.value, y2.value, x3.value, y3.value]
     end
 
+    # Unpacks arguments +X+[1..2] and +Y+[1..2] from Sass to Ruby objects.
+    def quadratic_curve(x1, y1, x2, y2)
+      [x1.value, y1.value, x2.value, y2.value]
+    end
+
     # Unpacks arguments +X+, +Y+, +radius+ and +angle+[1..2] from Sass to Ruby objects.
     def arc(x, y, radius, angle1, angle2)
       [x.value, y.value, radius.value, angle1.value * (Math::PI / 180.0), angle2.value * (Math::PI / 180.0)]

data/lib/canvas/functions/canvas.rb

@@ -16,6 +16,34 @@ module Compass::Canvas
         end
         klass.new(*Compass::Canvas::Functions.unpack(args).flatten)
       end
+
+      # Gets the width of a {Compass::Canvas::Backend}.
+      #
+      # @return [Compass::Canvas::Backend] The width of the backend.
+      def width_of(canvas)
+        Sass::Script::Number.new(canvas.property(:width))
+      end
+
+      # Gets the height of a {Compass::Canvas::Backend}.
+      #
+      # @return [Compass::Canvas::Backend] The height of the backend.
+      def height_of(canvas)
+        Sass::Script::Number.new(canvas.property(:height))
+      end
+
+      # Gets the X position of the current path on a {Compass::Canvas::Backend}.
+      #
+      # @return [Compass::Canvas::Backend] The X position of the current backend path.
+      def path_x(canvas)
+        Sass::Script::Number.new(canvas.property(:x))
+      end
+
+      # Gets the Y position of the current path on a {Compass::Canvas::Backend}.
+      #
+      # @return [Compass::Canvas::Backend] The Y position of the current backend path.
+      def path_y(canvas)
+        Sass::Script::Number.new(canvas.property(:y))
+      end
     end
   end
 end

data/stylesheets/_canvas.scss

@@ -1,3 +1,27 @@
 @import 'canvas/context';
 @import 'canvas/path';
 @import 'canvas/pattern';
+
+// @function width-of(canvas) {}
+// @function height-of(canvas) {}
+// @function path-x(canvas) {}
+// @function path-y(canvas) {}
+
+@function put-image($file, $x: 0, $y: 0) {
+  $canvas: canvas($file);
+  @if ($x == 'repeat') {
+    @return (
+      brush($canvas, $x)
+      paint
+    );
+  } @else {
+    @return (
+      save
+        translate($x, $y)
+        brush($canvas)
+        rectangle(0, 0, width-of($canvas), height-of($canvas))
+        fill
+      restore
+    );
+  }
+}

data/stylesheets/canvas/_path.scss

@@ -1,2 +1,3 @@
+@import 'canvas/path/curves';
 @import 'canvas/path/primitives';
 @import 'canvas/path/shapes';

data/stylesheets/canvas/path/_curves.scss

@@ -0,0 +1,7 @@
+@function bezier-curve-to($x1, $y1, $x2, $y2, $x3, $y3) {
+  @return curve-to($x1, $y1, $x2, $y2, $x3, $y3);
+}
+
+@function quadratic-curve-to($x1, $y1, $x2, $y2) {
+  @return canvas-path('quadratic_curve', $x1, $y1, $x2, $y2);
+}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: compass-canvas
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Stan Angeloff
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-14 00:00:00 Z
+date: 2011-08-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: compass
@@ -79,9 +79,10 @@ files:
 - stylesheets/canvas/_pattern.scss
 - stylesheets/canvas/_path.scss
 - stylesheets/canvas/_context.scss
+- stylesheets/canvas/path/_curves.scss
 - stylesheets/canvas/path/_primitives.scss
 - stylesheets/canvas/path/_shapes.scss
-- plugins/drop-shadow.rb
+- plugins/drop_shadow.rb
 homepage: http://StanAngeloff.github.com/compass-canvas/
 licenses: []