nutils 0.5.0

data/README.md

@@ -0,0 +1,16 @@
+# Nutils Readme
+
+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.
+* **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 Sources
+* **filesystem_customizable** Allows an array for source directories and for layout directories.
+
+## Contact
+You can reach me at <arnau.siches@gmail.com>.

data/lib/nutils/data_sources/filesystem_customizable.rb

@@ -0,0 +1,40 @@
+module Nutils
+  module DataSources
+
+    # @author Arnau Siches
+    #
+    # @version 1.0.0
+    #
+    # The +filesystem_customizable+ data source allows an array for source 
+    # directories and for layout directories.
+    # Inherits from +Nanoc3::DataSources::FilesystemUnified+fromstores.
+    #
+    # @example config.yaml excerpt
+    #   data_sources:
+    #     -
+    #       type: filesystem_customizable
+    #       config:
+    #         source_dir: ["src"]
+    #         layout_dir: ["layouts", "other_layouts"]
+    #
+    # @see Nanoc3::DataSources::FilesystemUnified
+    class FilesystemCustomizable < Nanoc3::DataSources::FilesystemUnified
+      identifier :filesystem_customizable
+
+      def setup
+        # Create directories
+        (config[:source_dir] + config[:layout_dir]).each { |dir| FileUtils.mkdir_p dir }
+      end
+      def items
+        config[:source_dir].map do |dir|
+          load_objects(dir, 'item', Nanoc3::Item)
+        end.flatten
+      end
+      def layouts
+        config[:layout_dir].map do |dir|
+          load_objects(dir, 'layout', Nanoc3::Layout)
+        end.flatten
+      end
+    end
+  end
+end

data/lib/nutils/data_sources.rb

@@ -0,0 +1,7 @@
+module Nutils
+  module DataSources
+    autoload "FilesystemCustomizable", "nutils/data_sources/filesystem_customizable"
+
+    ::Nanoc3::DataSource.register "::Nutils::DataSources::FilesystemCustomizable",  :filesystem_customizable
+  end
+end

data/lib/nutils/filters/beautify.rb

@@ -0,0 +1,33 @@
+module Nutils
+  module Filters
+
+    # @author Arnau Siches
+    # @author Choan Gálvez
+    #
+    # @version 0.5.0
+    #
+    # @note Requires htmlbeautifer
+    #
+    # @todo Pass parameters to the HtmlBeautifer engine.
+    class Beautify < Nanoc3::Filter
+
+      identifier :beautify
+      type :text
+
+      # Runs the content through [htmlbeautifier](http://github.com/threedaymonk/htmlbeautifier/).
+      # This method takes no options.
+      #
+      # @param [String] content The content to filter.
+      #
+      # @return [String] The retabed HTML.
+      def run(content, params = {})
+        require "htmlbeautifier/beautifier"
+        buffer = ""
+        ::HtmlBeautifier::Beautifier.new(buffer).scan(content)
+        buffer
+      end
+
+    end
+
+  end
+end

data/lib/nutils/filters/sprockets.rb

@@ -0,0 +1,44 @@
+module Nutils
+  module Filters
+
+    # @author Arnau Siches
+    #
+    # @version 1.0.0
+    #
+    # @note Requires «sprockets»
+    class SprocketWheel < Nanoc3::Filter
+
+      identifier :sprockets
+      type :text
+
+      # Concatenate the Javascript content through [Sprockets](http://getsprockets.org).
+      # This method takes no options.
+      #
+      # @param [String] content The content to filter.
+      #
+      # @return [String] The filtered content.
+      def run(content, params={})
+        require "sprockets"
+        require "tempfile"
+
+        tmp_file = Tempfile.new("sprockets.tmp", File.dirname(@item[:filename]))
+
+        tmp_file.puts content
+        tmp_file.open
+        
+        source_files = tmp_file.path
+        load_path = params[:load_path] || File.dirname(@item[:filename])
+
+        params.merge!({
+          :load_path => load_path,
+          :source_files => [source_files]
+        })
+
+        secretary = ::Sprockets::Secretary.new(params)
+        secretary.install_assets if params[:asset_root]
+        secretary.concatenation
+
+      end
+    end
+  end
+end

data/lib/nutils/filters/svg2png.rb

@@ -0,0 +1,96 @@
+module Nutils
+  module Filters
+
+    # @author Arnau Siches
+    # @author Choan Gálvez
+    #
+    # @version 0.2.0
+    #
+    # @note Requires «rjb»
+    class SvgToPng < Nanoc3::Filter
+      
+      identifier :svg_to_png
+      type :text => :binary
+      
+      def initialize(hash = {})
+        require "rjb"
+        require "tempfile"
+
+        Rjb::load(classpath = '.', [ '-Djava.awt.headless=true', '-Dapple.awt.graphics.UseQuartz=false' ])
+        @fileOutputStream = Rjb::import("java.io.FileOutputStream")
+        @pngTranscoder = Rjb::import("org.apache.batik.transcoder.image.PNGTranscoder")
+        @transcoderInput = Rjb::import("org.apache.batik.transcoder.TranscoderInput")
+        @transcoderOutput = Rjb::import("org.apache.batik.transcoder.TranscoderOutput")
+        @float = Rjb::import("java.lang.Float")
+        @integer = Rjb::import("java.lang.Integer")
+        @color = Rjb::import("java.awt.Color")
+        @@_initialized = true
+        super
+      end
+
+      # Runs the content through [Batik](http://xmlgraphics.apache.org/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.
+      #
+      # @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.
+      #
+      # @option params [Integer] :heigth (nil) The height of the result. Mask for the
+      #   +KEY_HEIGHT+ key.
+      #
+      # @option params [Integer] :width (nil) The width of the result. Mask for the
+      #   +KEY_WIDTH+ key.
+      #
+      # @return [String] The filtered content.
+      def run(content, params = {})
+        t = @pngTranscoder.new
+
+        opts = {
+          :background_color => nil,
+          :dpi => 72,
+          :height => nil,
+          :width => nil,
+        }.merge(params)
+
+        t.addTranscodingHint(@pngTranscoder.KEY_WIDTH, @float.new(opts[:width])) if opts[:width]
+        t.addTranscodingHint(@pngTranscoder.KEY_HEIGHT, @float.new(opts[:height])) if opts[:height]
+        t.addTranscodingHint(@pngTranscoder.KEY_PIXEL_TO_MM, @float.new(254 / opts[:dpi])) if opts[:dpi]
+        t.addTranscodingHint(@pngTranscoder.KEY_BACKGROUND_COLOR, @color.new(hex2int(opts[:background_color]))) if opts[:background_color]
+        # t.addTranscodingHint(@pngTranscoder.KEY_BACKGROUND_COLOR, @color.decode('#FC0'))
+
+        tempfile = Tempfile.new(filename.gsub(/[^a-zA-Z0-9]/, '-'), ".")
+        temppath = tempfile.path
+        tempfile.puts content
+        tempfile.close
+
+        uri = "file:" + File.expand_path(temppath)
+
+        input = @transcoderInput.new(uri)
+        ostream = @fileOutputStream.new(output_filename)
+        output = @transcoderOutput.new(ostream)
+        t.transcode(input, output)
+
+        ostream.flush()
+        ostream.close()
+      end
+
+      # Converts an hexadecimal number with the format +#FC0+ or +#FFCC00+ to its integer representation.
+      # 
+      # @param [String] input The hexadecimal number.
+      # 
+      # @return [Integer] The corresponding integer.
+      def hex2int(input)
+        hexnum = input.delete("#")
+        raise ArgumentError, "Got #{input}. Hexadecimal number must have the form #FC0 or #FFCC00." unless (hexnum.length == 3 or hexnum.length == 6)
+        (hexnum.length == 3) ? hexnum.map { |i| i + i }.to_s.hex : hexnum.hex
+      end
+
+    end
+  end
+end

data/lib/nutils/filters/yuicompressor.rb

@@ -0,0 +1,28 @@
+module Nutils
+  module Filters
+
+    # @author Arnau Siches
+    #
+    # @version 1.0.0
+    #
+    # @note Requires «yui-compressor»
+    class YuiCompressor < Nanoc3::Filter
+      
+      identifier :yuicompressor
+      type :text
+
+      # Compress the content with [YUI Compressor](http://developer.yahoo.com/yui/compressor/).
+      # This method takes no options.
+      #
+      # @param [String] content The content to filter.
+      #
+      # @return [String] The filtered content.
+      def run(content, params={})
+        require "yui/compressor"
+        compressor = ::YUI::JavaScriptCompressor.new(params)
+        compressor.compress(content)
+      end
+      
+    end
+  end
+end

data/lib/nutils/filters.rb

@@ -0,0 +1,13 @@
+module Nutils
+  module Filters
+    autoload "Beautify", "nutils/filters/beautify"
+    autoload "Sprockets", "nutils/filters/sprockets"
+    autoload "Svg2Png", "nutils/filters/svg2png"
+    autoload "YuiCompressor", "nutils/filters/yuicompressor"
+
+    ::Nanoc3::Filter.register "::Nutils::Filters::Beautify", :beautify
+    ::Nanoc3::Filter.register "::Nutils::Filters::Sprockets", :sprockets
+    ::Nanoc3::Filter.register "::Nutils::Filters::Svg2Png", :svg2png
+    ::Nanoc3::Filter.register "::Nutils::Filters::YuiCompressor", :yuicompressor
+  end
+end

data/lib/nutils.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Nutils
+
+  # The current nutils version.
+  VERSION = "0.5.0"
+
+end
+
+# Load requirements
+require "nanoc3"
+
+# Load nutils
+require "nutils/data_sources"
+require "nutils/filters"

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: nutils
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Arnau Siches
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nanoc3
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 1
+        - 2
+        version: 3.1.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rjb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yui-compressor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: htmlbeautifier
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sprockets
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+description: Nutils is a set of utilities like filters, data_sources and helpers for Nanoc3.
+email: arnau.siches@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- lib/nutils/data_sources/filesystem_customizable.rb
+- lib/nutils/data_sources.rb
+- lib/nutils/filters/beautify.rb
+- lib/nutils/filters/sprockets.rb
+- lib/nutils/filters/svg2png.rb
+- lib/nutils/filters/yuicompressor.rb
+- lib/nutils/filters.rb
+- lib/nutils.rb
+- README.md
+has_rdoc: yard
+homepage: http://github.com/arnau/Nutils/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A set of utilities for Nanoc3.
+test_files: []
+