alexander 0.5.0 → 0.6.0

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.idea
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -2,6 +2,8 @@
 
 A Rack middleware to process XML through XSLT to generate HTML.
 
+It use the `<?xml-stylesheet ...?>` processing instruction found in XML to find wich XSLT to use. It works only if the XSLT is hosted inside the same application as the XML, as it does another call the the same Rack stack to found it.
+
 The process occur only:
 
 1. If the file served is a XML (`mime-type: "application/xml"`);
@@ -10,6 +12,8 @@ The process occur only:
 
 If *any* of these conditions is *false*, Alexander will do nothing.
 
+The XSLT processing can be forced in a XSLT enable browser passing "`force_xslt_parameter=true`" as URL parameter (`QUERY_STRING`). The parameter name is intentionaly long and specific to minimize chances of conflict.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,6 +34,10 @@ Add to your Rack stack:
 
     use Alexander::XslProcessor
 
+If you want to force ALL requests to be processed by the server:
+
+    use Alexander::XslProcessor, force_xslt_parameter: true
+
 ## Browsers with XSLT processing support:
 
 * Chrome &gt;= 1.0
@@ -38,6 +46,11 @@ Add to your Rack stack:
 * Internet Explorer &gt;= 6.0
 * Opera &gt;= 9.0
 
+## CHANGELOG
+
+0.5.0 - Initial published version
+0.5.1 - "force_xslt_processing" parameter
+
 ## TODO
 * Better error handling:
   * Invalid XML.

data/lib/alexander/version.rb

@@ -1,3 +1,3 @@
 module Alexander
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/alexander/xsl_processor.rb

@@ -3,8 +3,9 @@ require 'useragent'
 require 'nokogiri'
 
 module Alexander
-  Browser = Struct.new(:browser, :version)
+  FORCE_PROCESSING_PARAMETER = "force_xslt_processing"
 
+  Browser = Struct.new(:browser, :version)
   XSLT_ENABLE_BROWSERS = [
     Browser.new("Chrome", "1.0"),
     Browser.new("Firefox", "3.0"),
@@ -14,21 +15,26 @@ module Alexander
   ]
 
   class XslProcessor
-    def initialize(app)
+
+    def initialize(app, options = {})
       @app = app
+      @options = options
     end
 
     def call(env)
-      status, headers, body = @app.call(env)
+      response = @app.call(env)
+      status, headers, body = response
 
-      return [status, headers, body] unless xml?(headers)
-      return [status, headers, body] if xlst_enable_browser?(env)
+      return response unless xml?(headers)
 
-      html_response = to_html(env, body)
-      return [status, headers, body] unless html_response
+      force = force_processing(env)
+      return response if xlst_enable_browser?(env) && !force
+
+      html_body = to_html(env, body)
+      return response unless html_body
 
       headers["Content-type"] = "text/html"
-      Rack::Response.new([html_response], status, headers).finish
+      Rack::Response.new([html_body], status, headers).finish
     end
 
     def xml?(headers)
@@ -41,6 +47,12 @@ module Alexander
       XSLT_ENABLE_BROWSERS.detect { |browser| user_agent >= browser }
     end
 
+    def force_processing(env)
+      return true if @options[FORCE_PROCESSING_PARAMETER.to_sym]
+      request = Rack::Request.new(env)
+      request.params[FORCE_PROCESSING_PARAMETER] == "true"
+    end
+
     def to_html(env, body)
       xml = body_to_string(body)
       xslt_request = detect_xslt_processing_instruction(xml)

data/run_guard.rb

@@ -0,0 +1 @@
+exec "guard"

data/spec/alexander/xsl_processor_spec.rb

@@ -44,11 +44,11 @@ CURL = "curl/7.21.6 (x86_64-pc-linux-gnu) libcurl/7.21.6 OpenSSL/1.0.0e zlib/1.2
 describe Alexander::XslProcessor do
 
   def env_with_chrome
-    {"HTTP_USER_AGENT" => CHROME_18}
+    {"HTTP_USER_AGENT" => CHROME_18, "rack.input" => ""}
   end
 
   def env_with_curl
-    {"HTTP_USER_AGENT" => CURL}
+    {"HTTP_USER_AGENT" => CURL, "rack.input" => ""}
   end
 
   before do
@@ -74,6 +74,14 @@ describe Alexander::XslProcessor do
         status, headers, response = @filter.call(env_with_chrome)
         response.body.must_equal @dummy_app.xml.body
       end
+      describe "when receive a force process parameter" do
+        it "should parse XML to HTML" do
+          status, headers, response = @filter.call(env_with_chrome.merge({"QUERY_STRING" => "force_xslt_processing=true"}))
+          status.must_equal 200
+          headers["Content-type"].must_equal "text/html"
+          response.body.must_equal ["<html><body></body></html>\n"]
+        end
+      end
     end
     describe "when request came from a XSLT NOT enable browser" do
       it "should parse XML to HTML" do
@@ -94,6 +102,17 @@ describe Alexander::XslProcessor do
         response.body.must_equal @dummy_app.xml.body
       end
     end
+    describe "when response is XML" do
+      describe "when filter is set to force XSLT processing" do
+        it "should parse XML to HTML" do
+          @filter = Alexander::XslProcessor.new(@dummy_app, force_xslt_processing: true)
+          status, headers, response = @filter.call(env_with_chrome)
+          status.must_equal 200
+          headers["Content-type"].must_equal "text/html"
+          response.body.must_equal ["<html><body></body></html>\n"]
+        end
+      end
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alexander
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000 Z
+date: 2012-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -173,6 +173,7 @@ files:
 - lib/alexander.rb
 - lib/alexander/version.rb
 - lib/alexander/xsl_processor.rb
+- run_guard.rb
 - spec/alexander/xsl_processor_spec.rb
 homepage: http://github.com/ruliana/alexander
 licenses: []