rack-xsl 0.2.6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Savonix Corporation
+
+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.md

@@ -0,0 +1,52 @@
+# Rack XSL README
+
+Summary
+-------
+
+A rack middleware for transforming XML with XSL.
+
+Configuration
+-------------
+
+This is how I would like it to work, but its not there yet:
+
+<pre class="sh_ruby">
+require 'xml/xslt'
+require 'rack/xsl'
+
+myxslfile = File.dirname(__FILE__) + '/app/views/layouts/xsl/html_main.xsl'
+use Rack::XSLView,
+  :myxsl => XML::XSLT.new(),
+  :noxsl => ['/raw/', '/s/js/', '/s/css/', '/s/img/'],
+  :passenv => ['PATH_INFO', 'RACK_MOUNT_PATH', 'RACK_ENV'],
+  :xslfile => File.open(myxslfile) {|f| f.read },
+  :excludehtml => false,
+  :reload => true,
+  :tidy => {  :doctype => 'omit',
+    :numeric_entities => 1,
+    :drop_proprietary_attributes => 1,
+    :preserve_entities => 0,
+    :input_encoding => 'utf8',
+    :char_encoding => 'utf8',
+    :output_encoding => 'utf8',
+    :error_file => '/tmp/tidyerr.txt',
+    :force_output => 1,
+    :alt_text => '', 
+    :tidy_mark => 0,
+    :logical_emphasis => 1,
+  }
+
+</pre>
+
+
+Resources
+---------
+
+* <http://www.docunext.com/wiki/Rack-XSLView>
+* <http://github.com/docunext/Rack-XSLView>
+
+
+Thanks
+------
+
+The rack-rewrite gem was very helpful in figuring out how to write rack middleware with lots of options.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-xsl"
+    gem.summary = %Q{XSL rack middleware.}
+    gem.description = %Q{Rack middleware for transforming XML with XSL.}
+    gem.email = 'albert.lash@docunext.com'
+    gem.homepage = 'http://www.docunext.com/wiki/Rack-XSLView'
+    gem.authors = ['Albert Lash']
+    gem.rubyforge_project = ''
+    gem.add_development_dependency 'shoulda'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = 'rdoc'
+  end
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler'
+end
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+task :spec => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-xslview #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.6

data/lib/output.xhtml10.xsl

@@ -0,0 +1,32 @@
+<!--
+Program: 1bb02b59
+Component: output.xhtml10.xsl
+Copyright: Savonix Corporation
+Author: Albert L. Lash, IV
+License: Apache License, Version 2.0
+
+Copyright 2009 Savonix Corporation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+xmlns="http://www.w3.org/1999/xhtml">
+
+<xsl:import href="http://github.com/docunext/1bb02b59/raw/master/standard.html.xsl"/>
+
+
+<xsl:output method="xml" encoding="UTF-8" omit-xml-declaration="no"
+doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
+doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN" indent="yes"/>
+
+</xsl:stylesheet>

data/lib/rack/xsl.rb

@@ -0,0 +1,126 @@
+# Copyright 2010 Savonix Corporation
+# Author Albert L. Lash, IV
+# License MIT
+require 'rexml/document'
+module Rack
+  class XSL
+
+    class RackXSLError < StandardError ; end
+
+    def initialize(app, options)
+      @app = app
+      @options = {:myxsl => nil}.merge(options)
+      if @options[:myxsl].nil?
+        require 'rexml/document'
+        @xslt = XML::XSLT.new()
+        @xslt.xsl = REXML::Document.new '<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml"><xsl:import href="http://github.com/docunext/1bb02b59/raw/master/standard.html.xsl"/><xsl:output method="xml" encoding="UTF-8" omit-xml-declaration="no" doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN" indent="yes"/></xsl:stylesheet>'
+      else
+        @xslt = @options[:myxsl]
+      end
+    end
+
+    def call(env)
+      # No matter what, @app will be called
+      status, headers, body = @app.call(env)
+      original_response = Array[status, headers, body]
+      exluded_status = Array[204, 301, 302, 304]
+      return original_response if exluded_status.include?(status) || body.nil?
+
+      return original_response unless headers["Content-Type"].to_s.match(/(ht|x)ml/) 
+
+      # If setup includes paths to exclude from xslt processing, check them
+      checknoxsl(env) if @options[:noxsl]
+
+      # Obtain entire request body, ensuring sure it can be processed
+      myxml = getResponse(body)
+	
+      # One more check for an empty respone
+      return original_response if myxml.empty?
+
+      # Should XSL file be reloaded?
+      if @options[:reload] == true
+        @xslt     = XML::XSLT.new()
+        @xslt.xsl = REXML::Document.new @options[:xslfile]
+      end
+
+      unless @options[:tidy].nil?
+        input_xml = myxml.include?('http://www.w3.org/1999/xhtml') ? 0 : 1
+        output = myxml.include?('http://www.w3.org/1999/xhtml') ? 'output_xhtml' : 'output_xml'
+        @options[:tidy][:input_xml] = input_xml
+        @options[:tidy][output.to_sym] = 1
+        nuxml = ''
+        nuxml = TidyFFI::Tidy.new(myxml, @options[:tidy]).clean
+        myxml = nuxml
+      end
+      @xslt.xml = myxml
+
+      # If setup includes env vars to pass through as params, do so
+      unless @options[:passenv].nil?
+        @myhash = {}
+        @options[:passenv].each { |envkey|
+          # Does env var exist?
+          @myhash[envkey] = "#{env[envkey]}" if env[envkey]
+        }
+        @xslt.parameters = @myhash unless @myhash.empty?
+      end
+
+      # Perform the transformation
+      newbody = Array.[](@xslt.serve)
+
+      # If we've made it this far, we can alter the headers
+      headers.delete('Content-Length')
+      headers['Content-Length'] = newbody[0].length.to_s
+
+      # Content type override?
+      unless @options[:content_type].nil?
+        headers["Content-Type"] = @options[:content_type]
+      end
+
+      [status, headers, newbody]
+
+    rescue RackXSLError
+      # TODO Log: "Rack XSL not processed" if env['RACK_ENV'] == 'development'
+      original_response
+    end
+
+    private
+    def checknoxsl(env)
+      @options[:noxsl].each { |path|
+        raise RackXSLError if env["PATH_INFO"].index(path)
+      }
+    end
+    def getResponse(body)
+      newbody = []
+      body.each { |part|
+        # Only check the first chunk to ensure 1) its not HTML and 2) its XML
+        checkForXml(part) if newbody.empty?
+        newbody << part.to_s
+      }
+      return newbody.join('')
+    end
+    def checkForXml(x)
+      # Abort processing if content cannot be processed by libxslt
+      #puts "test for xml"
+      #puts x[0]
+      if RUBY_VERSION > '1.9'
+        raise RackXSLError unless x[0] == '<'
+      else
+        raise RackXSLError unless x[0] == 60
+      end
+      #puts "end xml test"
+      if @options[:excludehtml] == true
+        raise RackXSLError if x.include? '<html'
+      end
+    end
+
+    def choosesheet(env)
+      # Not used yet, this may be used to match stylesheets with paths
+      @options[:xslhash].each_key { |path|
+        if env["PATH_INFO"].index(path)
+          return @options[:xslhash][path]
+        end
+      }
+      return false
+    end
+  end
+end

data/test/rack-xslview_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+require 'xml/xslt'
+
+class RackXslviewTest < Test::Unit::TestCase
+
+  def call_args(overrides={})
+    {'REQUEST_URI' => '/rlksdjfkj', 'PATH_INFO' => '/notsure', 'RACK_MOUNT_PATH' => '/something'}.merge(overrides)
+
+  end
+
+
+  def self.should_not_halt
+    should "not halt the rack chain" do
+      @app.expects(:call).once
+      @rack.call(call_args)
+    end
+  end
+
+  def self.should_be_a_rack_response
+    should 'be a rack a response' do
+      ret = @rack.call(call_args)
+      assert ret.is_a?(Array), 'return value is not a valid rack response'
+      assert_equal 3, ret.size, 'should have 3 arguments'
+    end
+  end
+
+  
+  context 'Given an app' do
+    setup do
+      @app = Class.new { def call(app); true; end }.new
+    end
+  
+    context 'Still learning how to write these tests...' do
+      setup {
+        omitpaths = [/^\/raw/, '/s/js/', '/s/css/']
+        passenv = ['PATH_INFO', 'RACK_MOUNT_PATH']
+        @rack = Rack::XSL.new(@app, :noxsl => omitpaths, :passenv => passenv)
+      }
+      should_be_a_rack_response
+      should_not_halt
+    end
+    context 'Trying out the xslhash' do
+      setup {
+        omitpaths = [/^\/raw/, '/s/js/', '/s/css/']
+        xslhash = { "/path/alskjddf" => "test.xsl",  /specific\.xml$/ => 'different.xsl' }
+        xslhash.default("/path/to/output.xhtml10.xsl")
+        @rack = Rack::XSL.new(@app, :noxsl => omitpaths, :xslhash => xslhash)
+      }
+      should_be_a_rack_response
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack/xsl'
+
+class Test::Unit::TestCase
+end
+
+TEST_ROOT = File.dirname(__FILE__)

data/test/test_install.rb

@@ -0,0 +1 @@
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: rack-xsl
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 6
+  version: 0.2.6
+platform: ruby
+authors: 
+- Albert Lash
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Rack middleware for transforming XML with XSL.
+email: albert.lash@docunext.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/output.xhtml10.xsl
+- lib/rack/xsl.rb
+- test/rack-xslview_test.rb
+- test/test_helper.rb
+- test/test_install.rb
+has_rdoc: true
+homepage: http://www.docunext.com/wiki/Rack-XSLView
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ""
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: XSL rack middleware.
+test_files: 
+- test/rack-xslview_test.rb
+- test/test_helper.rb
+- test/test_install.rb