rack-nokogiri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 943e6fbfd41f3f67d8da5da8e3dd2c1be8ccdd9c
+  data.tar.gz: 923c33ec16218112d786370b6d43de937b3e1abd
+SHA512:
+  metadata.gz: 092d69bd42defc30b27566b120429a929ffbef253e6309c10d162175aa9f40c335602a0ee930418fa7b0ea97a5e0ef460041bb290bc7682c15d748cba4931180
+  data.tar.gz: a8a051762ae0cb1cb7eb496a1b6ad87bc0193db9dda006bbd6b955327dd58dfcafd1cf564aeebe44077cc3f623ddb37e384d4dced9d580230ed8402b962011f6

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/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-highlighter.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r{^spec/(.*)_spec\.rb})
+  watch(%r{^lib/rack/(.*)([^/]+)\.rb}) { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb})     { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Daniel Perez Alvarez
+
+MIT License
+
+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,103 @@
+# Rack::Nokogiri [![Build Status](https://secure.travis-ci.org/unindented/rack-nokogiri.png)](http://travis-ci.org/unindented/rack-nokogiri) [![Dependency Status](https://gemnasium.com/unindented/rack-nokogiri.png)](https://gemnasium.com/unindented/rack-nokogiri)
+
+Rack Middleware that allows you to manipulate the nodes in your HTML response however you like.
+
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'rack-nokogiri'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install rack-nokogiri
+```
+
+
+## Usage
+
+### Adding Rack::Nokogiri to a Rails application
+
+To wrap all `<p>` with class `target` with a `div`, we could do something like this:
+
+```ruby
+require 'rack/nokogiri'
+
+class Application < Rails::Application
+  config.middleware.use Rack::Nokogiri, css: 'p.target' do |nodes|
+    nodes.wrap '<div class="wrapper"></div>'
+  end
+end
+```
+
+If we wanted to use XPath instead of CSS selectors, we could do this instead:
+
+```ruby
+require 'rack/nokogiri'
+
+class Application < Rails::Application
+  config.middleware.use Rack::Nokogiri, xpath: "//p[@class='target']" do |nodes|
+    nodes.wrap '<div class="wrapper"></div>'
+  end
+end
+```
+
+### Adding Rack::Nokogiri to a Sinatra application
+
+For Sinatra we would do:
+
+```ruby
+require 'sinatra'
+require 'rack/nokogiri'
+
+use Rack::Nokogiri, css: 'p.target' do |nodes|
+  nodes.wrap '<div class="wrapper"></div>'
+end
+
+get('/') do
+  '<p class="target">Hello World!</p>'
+end
+```
+
+### Adding Rack::Nokogiri to a Rackup application
+
+For a Rackup app we would do:
+
+```ruby
+require 'rack'
+require 'rack/nokogiri'
+
+use Rack::Nokogiri, css: 'p.target' do |nodes|
+  nodes.wrap '<div class="wrapper"></div>'
+end
+
+run lambda { |env|
+  [200, {'Content-Type' => 'text/html'}, ['<p class="target">Hello World!</p>']]
+}
+```
+
+
+## Meta
+
+* Code: `git clone git://github.com/unindented/rack-nokogiri.git`
+* Home: <https://github.com/unindented/rack-nokogiri/>
+
+
+## Contributors
+
+* Daniel Perez Alvarez ([unindented@gmail.com](mailto:unindented@gmail.com))
+
+
+## License
+
+Copyright (c) 2013 Daniel Perez Alvarez ([unindented.org](http://unindented.org/)). This is free software, and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+# Test tasks.
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/*_spec.rb'
+end
+
+# Default task.
+
+task default: :test

data/lib/rack/nokogiri.rb

@@ -0,0 +1,53 @@
+require 'rack/nokogiri/version'
+
+require 'rack'
+require 'nokogiri'
+
+module Rack
+  class Nokogiri
+    include Rack::Utils
+
+    def initialize(app, opts = {}, &block)
+      @app = app
+      @opts = opts.select {|key, value| [:css, :xpath].include?(key) }
+      @block = block
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+      headers = HeaderHash.new(headers)
+
+      if should_process?(status, headers)
+        content = extract_content(response)
+
+        doc = ::Nokogiri::HTML(content)
+        process_nodes(doc)
+        content = doc.to_html
+
+        headers['content-length'] = bytesize(content).to_s
+        response = [content]
+      end
+
+      [status, headers, response]
+    end
+
+    def should_process?(status, headers)
+      !STATUS_WITH_NO_ENTITY_BODY.include?(status) &&
+         !headers['transfer-encoding'] &&
+          headers['content-type'] &&
+          headers['content-type'].include?('text/html')
+    end
+
+    def extract_content(response)
+      response.reduce('') { |memo, part| memo + part }
+    end
+
+    def process_nodes(doc)
+      nodes = ::Nokogiri::XML::NodeSet.new(doc)
+      nodes += doc.css(@opts[:css])     unless @opts[:css].nil?
+      nodes += doc.xpath(@opts[:xpath]) unless @opts[:xpath].nil?
+      @block.call(nodes) unless nodes.empty?
+    end
+
+  end
+end

data/lib/rack/nokogiri/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Nokogiri
+    VERSION = '0.1.0'
+  end
+end

data/rack-nokogiri.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rack/nokogiri/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'rack-nokogiri'
+  gem.version       = Rack::Nokogiri::VERSION
+  gem.authors       = ['Daniel Perez Alvarez']
+  gem.email         = ['unindented@gmail.com']
+  gem.description   = %q{Rack Middleware for node manipulation.}
+  gem.summary       = %q{Rack Middleware that allows you to manipulate the nodes in your response however you like.}
+  gem.homepage      = 'http://github.com/unindented/rack-nokogiri'
+
+  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.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 1.9.0'
+
+  gem.add_runtime_dependency 'rack',         '>= 1.0.0'
+  gem.add_runtime_dependency 'nokogiri',     '>= 1.4.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'minitest-reporters'
+  gem.add_development_dependency 'rack-test'
+
+  gem.add_development_dependency 'guard-minitest'
+  gem.add_development_dependency 'rb-inotify'
+  gem.add_development_dependency 'rb-fsevent'
+  gem.add_development_dependency 'rb-fchange'
+end

data/spec/nokogiri_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Rack::Nokogiri do
+
+  let(:app) do
+    create_app(status, headers, content, options) do |nodes|
+      nodes.wrap('<div class="greeting"></div>')
+    end
+  end
+
+  before do
+    get '/'
+  end
+
+  describe 'with a content-type other than `text/html`' do
+
+    let(:status) { 200 }
+    let(:headers) do
+      {
+        'Content-Type'   => 'text/plain',
+        'Content-Length' => content.length.to_s
+      }
+    end
+
+    let(:content) { 'foobar' }
+    let(:options) { {} }
+
+    it 'leaves the status untouched' do
+      last_response.status.must_equal status
+    end
+
+    it 'leaves the headers untouched' do
+      last_response.headers.must_equal headers
+    end
+
+    it 'leaves the content untouched' do
+      last_response.body.must_equal content
+    end
+
+  end
+
+  describe 'with a content-type of `text/html`' do
+
+    let(:status) { 200 }
+    let(:headers) do
+      {
+        'Content-Type'   => 'text/html',
+        'Content-Length' => content.length.to_s
+      }
+    end
+
+    let(:content) do
+      <<-eos
+      <!DOCTYPE html>
+      <html lang="en">
+        <head>
+          <meta charset="utf-8" />
+          <title>Some HTML</title>
+        </head>
+
+        <body>
+          <p class="hi">Hi!</p>
+          <p class="bye">Bye!</p>
+        </body>
+      </html>
+      eos
+    end
+
+    describe 'with a CSS selector' do
+      let(:options) { { css: 'p.hi' } }
+
+      it 'leaves the status untouched' do
+        last_response.status.must_equal status
+      end
+
+      it 'updates the headers with the new `Content-Length`' do
+        last_response.headers.wont_equal headers
+      end
+
+      it 'executes the block on the results of the selector' do
+        last_response.body.must_have_css ".greeting .hi"
+        last_response.body.wont_have_css ".greeting .bye"
+      end
+    end
+
+    describe 'with a XPath selector' do
+      let(:options) { { xpath: "//p[@class='hi']" } }
+
+      it 'leaves the status untouched' do
+        last_response.status.must_equal status
+      end
+
+      it 'updates the headers with the new `Content-Length`' do
+        last_response.headers.wont_equal headers
+      end
+
+      it 'executes the block on the results of the selector' do
+        last_response.body.must_have_xpath "//div[@class='greeting']/p[@class='hi']"
+        last_response.body.wont_have_xpath "//div[@class='greeting']/p[@class='bye']"
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'rack/test'
+require 'nokogiri'
+
+require File.expand_path('../support/expectations', __FILE__)
+require File.expand_path('../../lib/rack/nokogiri', __FILE__)
+
+include Rack::Test::Methods
+
+MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+
+def create_app(status, headers, content, options, &block)
+  app = lambda { |env| [status, headers, [content]] }
+  Rack::Nokogiri.new(app, options, &block)
+end

data/spec/support/expectations.rb

@@ -0,0 +1,33 @@
+module MiniTest::Assertions
+
+  def assert_has_css(html, css)
+    assert ::Nokogiri::HTML(html).css(css).length > 0,
+      "Expected HTML to produce results for CSS selector `#{css}`"
+  end
+
+  def refute_has_css(html, css)
+    refute ::Nokogiri::HTML(html).css(css).length > 0,
+      "Expected HTML to produce no results for CSS selector `#{css}`"
+  end
+
+  def assert_has_xpath(html, xpath)
+    assert ::Nokogiri::HTML(html).xpath(xpath).length > 0,
+      "Expected HTML to produce results for XPath selector `#{xpath}`"
+  end
+
+  def refute_has_xpath(html, xpath)
+    refute ::Nokogiri::HTML(html).xpath(xpath).length > 0,
+      "Expected HTML to produce no results for XPath selector `#{xpath}`"
+  end
+
+end
+
+module MiniTest::Expectations
+
+  infect_an_assertion :assert_has_css,   :must_have_css,   :reverse
+  infect_an_assertion :refute_has_css,   :wont_have_css,   :reverse
+
+  infect_an_assertion :assert_has_xpath, :must_have_xpath, :reverse
+  infect_an_assertion :refute_has_xpath, :wont_have_xpath, :reverse
+
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: rack-nokogiri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Perez Alvarez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fchange
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack Middleware for node manipulation.
+email:
+- unindented@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack/nokogiri.rb
+- lib/rack/nokogiri/version.rb
+- rack-nokogiri.gemspec
+- spec/nokogiri_spec.rb
+- spec/spec_helper.rb
+- spec/support/expectations.rb
+homepage: http://github.com/unindented/rack-nokogiri
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Rack Middleware that allows you to manipulate the nodes in your response
+  however you like.
+test_files:
+- spec/nokogiri_spec.rb
+- spec/spec_helper.rb
+- spec/support/expectations.rb