rack-stripper 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color --format=documentation --debugger

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rack/stripper.rb

@@ -0,0 +1,50 @@
+require 'rack'
+
+module Rack
+  class Stripper
+    VERSION = '1.0.0'
+
+    attr_accessor :add_xml_instruction
+    attr_accessor :is_xml_response
+
+    def initialize(app, options={})
+      @app = app
+      self.add_xml_instruction = options[:add_xml_instruction] || false
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      status, headers, response = @app.call(env)
+
+      if headers.has_key?('Content-Type')
+        self.is_xml_response = !headers['Content-Type'].match(/xml/).nil?
+      end
+
+      if response.respond_to?(:body)
+        stripped_body = process_body(response.body)
+        headers['Content-Length'] = stripped_body.bytesize if headers.has_key?('Content-Length')
+        response = Rack::Response.new(stripped_body, status, headers)
+        response.to_a
+      end
+    end
+
+    protected
+
+    def process_body(body)
+      body = body[0] if body.is_a?(Array)
+      body.strip!
+      if self.add_xml_instruction && doesnt_have_xml_instruction_already?(body) && self.is_xml_response
+        body = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n#{body}"
+      end
+      body
+    end
+
+    def doesnt_have_xml_instruction_already?(body)
+      match = body.match /<?xml version=/
+      match.nil?
+    end
+  end
+end

data/rack-stripper.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack/stripper', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Benjamin Kreeger']
+  gem.email         = ['ben@kree.gr']
+  gem.description   = 'Trims whitespace from response bodies sent through rack.'
+  gem.summary       = 'Trims whitespace from response bodies sent through rack.'
+  gem.homepage      = 'http://github.com/kreeger/rack-stripper'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'rack-stripper'
+  gem.require_paths = ['lib']
+  gem.version       = Rack::Stripper::VERSION
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'debugger'
+  gem.add_dependency 'rack', '>= 1.0.0'
+end

data/readme.markdown

@@ -0,0 +1,32 @@
+# Rack::Stripper: not as sexy as it sounds
+
+Rack::Stripper merely performs `String#strip` on the body of the response. I wrote this out of a need for this when Rails sends out RSS feeds (for some reason, the XML instruction is replaced with a blank line on outgoing RSS responses).
+
+## Installation
+
+Add this line to your application's Gemfile and `bundle install` it:
+
+    gem 'rack-stripper'
+
+Rack::Stripper is Rack middleware and can be used with any Rack-based application. In `config/application.rb`, place the following code.
+
+    config.middleware.use Rack::Stripper
+
+Then you'll see `Rack::Stripper` when you run `rake middleware`. Simple as that. More info about using Rack middleware with Rails can be found [here][rails]. If you'd like the middleware to ensure an XML instruction is added to the bodies to XML-based responses, make that line look like this.
+
+    config.middleware.use Rack::Stripper, add_xml_instruction: true
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+I made this. I released it under the [WTFPL][]. See LICENSE for details, if you're into that sort of thing.
+
+[rails]:     http://guides.rubyonrails.org/rails_on_rack.html
+[WTFPL]:     http://sam.zoy.org/wtfpl

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+require 'rack/stripper'
+
+class DummyWare
+
+  def initialize(body)
+    @body = body
+  end
+
+  def call(env)
+    status = 200
+    headers = {'Content-Type' => 'application/xml; charset=utf-8'}
+    response = Rack::Response.new(@body, status, headers)
+    response.to_a
+  end
+end

data/spec/stripper_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+rss_feed = <<-EOS
+
+<rss xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
+    <channel>
+        <title>Lookit me, I'm an RSS feed!</title>
+        <link>http://feedvalidator.org/</link>
+        <description>An RSS feed.</description>
+        <language>en-us</language>
+        <copyright>Your mom, last night.</copyright>
+        <docs>http://blogs.law.harvard.edu/tech/rss</docs>
+    </channel>
+</rss>
+EOS
+
+describe :rack do
+  describe :stripper do
+    before(:each) { @stripper = Rack::Stripper.new(DummyWare.new(rss_feed), {}) }
+
+    describe :_call do
+      it 'should clean up the body of a response' do
+        status, headers, response = @stripper._call({})
+        response.body.should_not be_nil
+        body = response.body.first
+        body.should start_with('<rss')
+        body.should == rss_feed.strip
+      end
+
+      it 'should add an instruction if told to do so' do
+        opts = { add_xml_instruction: true }
+        @stripper = Rack::Stripper.new(DummyWare.new(rss_feed), opts)
+        status, headers, response = @stripper._call({})
+        response.body.should_not be_nil
+        body = response.body.first
+        body.should start_with('<?xml version')
+      end
+    end
+
+    describe :doesnt_have_xml_instruction_already? do
+      let(:method) { :doesnt_have_xml_instruction_already? }
+
+      it 'should match on a basic xml instruction' do
+        string = "<?xml version='1.0'?>"
+        result = @stripper.send(method, string)
+        result.should be_false
+      end
+
+      it 'should match on a slightly more complicated xml instruction' do
+        string = "<?xml version=\"1.0\" standalone=\"no\"?>"
+        result = @stripper.send(method, string)
+        result.should be_false
+      end
+
+      it 'should match on a crazy nutshit complicated xml instruction' do
+        string = "<?xml version=\"1.0\" standalone=\"no\" charset=\"utf8\"?>"
+        result = @stripper.send(method, string)
+        result.should be_false
+      end
+
+      it "shouln't match on a missing xml instruction" do
+        string = "<?xml version='1.0' />"
+        result = @stripper.send(method, string)
+        result.should be_false
+      end
+    end
+
+    describe :process_body do
+      let(:method) { :process_body }
+      let(:before_and_after) { "      here's a sweet-ass string      " }
+      let(:line_breaks) { "\n\n\nhere's a sweet-ass string\n\n\n" }
+      let(:none_before) { "here's another string    \n"}
+      let(:none_after) { "  \n  here's another string"}
+
+      it 'should strip whitespace from the beginning of a string' do
+        result = @stripper.send(method, before_and_after)
+        result.should start_with("here's")
+        result.should_not start_with(' ')
+
+        result = @stripper.send(method, line_breaks)
+        result.should start_with("here's")
+        result.should_not start_with("\n")
+      end
+
+      it 'should strip whitespace from the end of a string' do
+        result = @stripper.send(method, before_and_after)
+        result.should end_with("string")
+        result.should_not end_with(' ')
+
+        result = @stripper.send(method, line_breaks)
+        result.should end_with("string")
+        result.should_not end_with("\n")
+      end
+
+      it "should leave a string alone at the beginning if there's not whitespace there" do
+        result = @stripper.send(method, none_before)
+        result.should end_with("string")
+        result.should start_with("here's")
+        result.should_not end_with(" ")
+        result.should_not end_with("\n")
+      end
+
+      it "should leave a string alone at the end if there's not whitespace there" do
+        result = @stripper.send(method, none_after)
+        result.should end_with("string")
+        result.should start_with("here's")
+        result.should_not start_with(" ")
+        result.should_not start_with("\n")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rack-stripper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Kreeger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Trims whitespace from response bodies sent through rack.
+email:
+- ben@kree.gr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- Rakefile
+- lib/rack/stripper.rb
+- rack-stripper.gemspec
+- readme.markdown
+- spec/spec_helper.rb
+- spec/stripper_spec.rb
+homepage: http://github.com/kreeger/rack-stripper
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4515052134336603542
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4515052134336603542
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Trims whitespace from response bodies sent through rack.
+test_files:
+- spec/spec_helper.rb
+- spec/stripper_spec.rb