nutils 0.5.5 → 0.6.0

data/README.md

@@ -5,6 +5,7 @@ A set of utilities for Nanoc3.
 ## Filters
 
 * **beautify** Retabs HTML code. Tested in Mac OS X 10.6, Ruby 1.8.7 and Nanoc 3.1.6.
+* **crop** Extracts the specified rectangle from the image.. Tested in Mac OS X 10.6, Ruby 1.8.7 and Nanoc 3.1.6.
 * **sprockets** Runs the content through [Sprockets](http://getsprockets.org)
 * **svg_to_png** Converts an SVG to PNG. Tested in Mac OS X 10.6, Ruby 1.8.7, Nanoc 3.1.6 and Batik 1.7.
 * **yuicompressor** Compress the content with [YUI Compressor](http://developer.yahoo.com/yui/compressor/). Tested in Mac OS X 10.6, Ruby 1.8.7, Nanoc 3.1.6 and yui-compressor 0.9.1.

data/lib/nutils/filters/crop.rb

@@ -0,0 +1,51 @@
+module Nutils
+  module Filters
+
+    # @author Arnau Siches
+    #
+    # @version 0.1.0
+    #
+    # @note Requires «RMagick»
+    class Crop < Nanoc3::Filter
+      
+      identifier :crop
+      type :binary
+
+      # Runs the content through {http://www.simplesystems.org/RMagick/doc/image1.html#crop RMagick#crop}.
+      #
+      # @param [String] filename The filename of the temporal file to filter.
+      #
+      # @option params [Integer] :x The x-offset of the rectangle relative 
+      #   to the upper-left corner of the image.
+      # 
+      # @option params [Integer] :y The y-offset of the rectangle relative 
+      #   to the upper-left corner of the image.
+      # 
+      # @option params [String] :width The width of the rectangle. This param can
+      #   handle string-expressions like +"image.columns - 1"+ where +image.columns+
+      #   is the width of the input image.
+      # 
+      # @option params [String] :height The height of the rectangle. This param can
+      #   handle string-expressions like +"image.rows - 1"+ where +image.rows+
+      #   is the height of the input image.
+      # 
+      # @return [File] The filtered content.
+      def run(filename, opts = {})
+        require 'RMagick'
+
+        raise ArgumentError, "x, y, width and height are required parameters." unless opts[:x] and opts[:y] and opts[:width] and opts[:height]
+
+        image = Magick::ImageList.new filename
+
+        width = eval(opts[:width])
+        height = eval(opts[:height])
+
+        image.crop(opts[:x], opts[:y], width, height).write output_filename
+
+      rescue Exception => e
+        raise ArgumentError, "#{e}\nSome parameters cannot be promoted to Integer."
+      end
+
+    end
+  end
+end

data/lib/nutils/filters/sass.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+module Nutils
+  module Filters
+    class Sass < Nanoc3::Filters::Sass
+      identifier :zass
+      type :text
+
+      # Runs the content through [Sass](http://sass-lang.com/).
+      # Parameters passed to this filter will be passed on to Sass.
+      #
+      # @param [String] content The content to filter
+      #
+      # @return [String] The filtered content
+      def run(content, params={})
+        require 'sass'
+
+        # Add imported_filename read accessor to ImportNode
+        # … but… but… nex3 said I could monkey patch it! :(
+        methods = ::Sass::Tree::ImportNode.instance_methods
+        if !methods.include?(:import_filename) && !methods.include?('import_filename')
+          ::Sass::Tree::ImportNode.send(:attr_reader, :imported_filename)
+        end
+
+        # Get options
+        options = params.dup
+        sass_filename = options[:filename] || (@item && @item[:content_filename])
+        options[:filename] ||= sass_filename
+
+        # Build engine
+        engine = ::Sass::Engine.new(content, options)
+
+        # Get import nodes
+        require 'set'
+        imported_nodes = []
+        unprocessed_nodes = Set.new([ engine.to_tree ])
+        until unprocessed_nodes.empty?
+          # Get an unprocessed node
+          node = unprocessed_nodes.each { |n| break n }
+          unprocessed_nodes.delete(node)
+
+          # Add to list of import nodes if necessary
+          imported_nodes << node if node.is_a?(::Sass::Tree::ImportNode)
+
+          # Mark children of this node for processing
+          node.children.each { |c| unprocessed_nodes << c }
+        end
+
+        # Get import paths
+        import_paths = (options[:load_paths] || []).dup
+        import_paths.unshift(File.dirname(sass_filename)) if sass_filename
+        # Get imported filenames
+        imported_filenames = imported_nodes.map do |node|
+          ::Sass::Files.find_file_to_import(node.imported_filename, import_paths)
+        end
+
+        # Convert to items
+        imported_items = imported_filenames.map do |filename|
+          pathname = Pathname.new(filename)
+          next unless pathname.file?
+          normalized_filename = pathname.realpath
+          @items.find { |i| i[:content_filename] && Pathname.new(i[:content_filename]).realpath == normalized_filename }
+        end.compact
+
+        # Require compilation of each item
+        imported_items.each do |item|
+          # Notify
+          Nanoc3::NotificationCenter.post(:visit_started, item)
+          Nanoc3::NotificationCenter.post(:visit_ended,   item)
+
+          # Raise unmet dependency error if item is not yet compiled
+          any_uncompiled_rep = item.reps.find { |r| !r.compiled? }
+          raise Nanoc3::Errors::UnmetDependency.new(any_uncompiled_rep) if any_uncompiled_rep
+        end
+
+        # Done
+        engine.render
+      end
+
+    end
+  end
+end

data/lib/nutils/filters/svg2png.rb

@@ -4,7 +4,7 @@ module Nutils
     # @author Arnau Siches
     # @author Choan Gálvez
     #
-    # @version 0.2.0
+    # @version 0.3.0
     #
     # @note Requires «rjb»
     class SvgToPng < Nanoc3::Filter
@@ -28,24 +28,31 @@ module Nutils
         super
       end
 
-      # Runs the content through [Batik](http://xmlgraphics.apache.org/batik/).
+      # Runs the content through {http://xmlgraphics.apache.org/batik/ Batik}.
       #
       # @param [String] content The content to filter.
       #
       # @option params [String] :background_color (nil) The background color with the 
       #   form +#FFCC00+ or +FC0+ of the result. Mask for the 
-      #   +KEY_BACKGROUND_COLOR+ key.
+      #   {http://xmlgraphics.apache.org/batik/javadoc/org/apache/batik/transcoder/image/ImageTranscoder.html#KEY_BACKGROUND_COLOR +KEY_BACKGROUND_COLOR+} key.
       #
       # @option params [Integer] :dpi (72) This parameter lets you use the pixel
       #   to millimeter conversion factor.
       #   This factor is used to determine how units are converted into pixels. 
-      #   Mask for the +KEY_PIXEL_TO_MM+ key.
+      #   Mask for the {http://xmlgraphics.apache.org/batik/javadoc/org/apache/batik/transcoder/SVGAbstractTranscoder.html#KEY_PIXEL_TO_MM +KEY_PIXEL_TO_MM+} key.
+      #
+      # @option params [Integer] :depth (nil) The color bit depth (i.e. 1, 2, 4, 8).
+      #   The resultant PNG will be an indexed PNG with color bit depth specified.
+      #   The height of the result. Mask for the {http://xmlgraphics.apache.org/batik/javadoc/org/apache/batik/transcoder/image/PNGTranscoder.html#KEY_INDEXED +KEY_INDEXED+} key.
+      #
+      # @option params [Float] :gamma (0) The gamma correction of the result. 
+      #   Mask for the {http://xmlgraphics.apache.org/batik/javadoc/org/apache/batik/transcoder/image/PNGTranscoder.html#KEY_GAMMA +KEY_GAMMA+} key.
       #
       # @option params [Integer] :heigth (nil) The height of the result. Mask for the
-      #   +KEY_HEIGHT+ key.
+      #   {http://xmlgraphics.apache.org/batik/javadoc/org/apache/batik/transcoder/SVGAbstractTranscoder.html#KEY_HEIGHT +KEY_HEIGHT+} key.
       #
       # @option params [Integer] :width (nil) The width of the result. Mask for the
-      #   +KEY_WIDTH+ key.
+      #   {http://xmlgraphics.apache.org/batik/javadoc/org/apache/batik/transcoder/SVGAbstractTranscoder.html#KEY_WIDTH +KEY_WIDTH+} key.
       #
       # @return [String] The filtered content.
       def run(content, params = {})
@@ -56,6 +63,8 @@ module Nutils
           :dpi => 72,
           :height => nil,
           :width => nil,
+          :gamma => 0,
+          :depth => nil,
         }.merge(params)
 
         t.addTranscodingHint(@pngTranscoder.KEY_WIDTH, @float.new(opts[:width])) if opts[:width]
@@ -64,6 +73,10 @@ module Nutils
         t.addTranscodingHint(@pngTranscoder.KEY_BACKGROUND_COLOR, @color.new(hex2int(opts[:background_color]))) if opts[:background_color] and opts[:background_color] != 'transparent'
         # t.addTranscodingHint(@pngTranscoder.KEY_BACKGROUND_COLOR, @color.decode('#FC0'))
 
+        t.addTranscodingHint(@pngTranscoder.KEY_GAMMA, @float.new(opts[:gamma]))
+        t.addTranscodingHint(@pngTranscoder.KEY_INDEXED, @integer.new(opts[:depth])) if opts[:depth]
+
+
         tempfile = Tempfile.new(filename.gsub(/[^a-zA-Z0-9]/, '-'), ".")
         temppath = tempfile.path
         tempfile.puts content
@@ -80,6 +93,7 @@ module Nutils
         ostream.close()
       end
 
+      private
       # Converts an hexadecimal number with the format +#FC0+ or +#FFCC00+ to its integer representation.
       # 
       # @param [String] input The hexadecimal number.

data/lib/nutils/filters.rb

@@ -1,11 +1,13 @@
 module Nutils
   module Filters
     autoload "Beautify", "nutils/filters/beautify"
+    autoload "Crop", "nutils/filters/crop"
     autoload "SprocketWheel", "nutils/filters/sprockets"
     autoload "SvgToPng", "nutils/filters/svg2png"
     autoload "YuiCompressor", "nutils/filters/yuicompressor"
 
     ::Nanoc3::Filter.register "::Nutils::Filters::Beautify", :beautify
+    ::Nanoc3::Filter.register "::Nutils::Filters::Crop", :crop
     ::Nanoc3::Filter.register "::Nutils::Filters::SprocketWheel", :sprockets
     ::Nanoc3::Filter.register "::Nutils::Filters::SvgToPng", :svg_to_png
     ::Nanoc3::Filter.register "::Nutils::Filters::YuiCompressor", :yuicompressor

data/lib/nutils.rb

@@ -3,7 +3,7 @@
 module Nutils
 
   # The current nutils version.
-  VERSION = "0.5.5"
+  VERSION = "0.6.0"
 
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nutils
 version: !ruby/object:Gem::Version 
-  hash: 1
-  prerelease: false
+  hash: 7
+  prerelease: 
   segments: 
   - 0
-  - 5
-  - 5
-  version: 0.5.5
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Arnau Siches
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-26 00:00:00 -05:00
+date: 2011-01-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,6 +106,8 @@ files:
 - lib/nutils/data_sources/filesystem_customizable.rb
 - lib/nutils/data_sources.rb
 - lib/nutils/filters/beautify.rb
+- lib/nutils/filters/crop.rb
+- lib/nutils/filters/sass.rb
 - lib/nutils/filters/sprockets.rb
 - lib/nutils/filters/svg2png.rb
 - lib/nutils/filters/yuicompressor.rb
@@ -145,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: A set of utilities for Nanoc3.