RubyGems - rack-gsub - Versions diffs - 0.0.0 → 0.1.0 - Mend

rack-gsub 0.0.0 → 0.1.0

Files changed (8) hide show

data/CHANGELOG CHANGED

@@ -1,2 +1,7 @@
+0.1.0 (July 18, 2010)
+* Explained the API in more detail in the README.
+* Gsub no longer replaces the text of form elements.
+* Added automated tests.
 0.0.0 (December 3, 2009)
 * Initial release.

data/LICENSE CHANGED

@@ -1,6 +1,6 @@
 The MIT License
-Copyright (c) 2009 Wyatt M. Greene
+Copyright (c) 2009, 2010 Wyatt M. Greene
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.rdoc CHANGED

@@ -13,7 +13,32 @@ occurrences of "the":
   use Rack::Gsub, "five" => "three", "the" => ""
-Note that you can use regular expressions, too, just like with Ruby's gsub.
 This is the syntax for using within Rails' config/environment.rb:
   config.middleware.use Rack::Gsub, "five" => "three", "the" => ""
+== Details
+You can use regular expressions, too, just like with Ruby's gsub:
+  use Rack::Gsub, /five/ => "5"
+  use Rack::Gsub, /f\w+e/ => "5"
+By default, the arguments are case-sensitive.  Use the /i regex switch to
+do a case-insensitive replace:
+  use Rack::Gsub, /five/i => "5"
+Only text within the body of the document is replaced.  The following will
+only replace the word "five" in the body, not in the page's title:
+  use Rack::Gsub, "five" => "5"
+Rack::Gsub does not replace the text inside form elements.
+Rack::Gsub eventually passes the arguments to Ruby's String.gsub method,
+so it behaves the same way.
+  use Rack::Gsub, /five/ => "5"
+  # gets turned into
+  string.gsub(/five/, "5")

data/Rakefile CHANGED

@@ -1,12 +1,23 @@
 require 'rake'
+require 'rake/testtask'
 require 'rubygems'
+desc 'Default: run unit tests.'
+task :default => :test
+desc 'Test Rack::Gsub'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name          = "rack-gsub"
-    s.version       = "0.0.0"
-    s.add_dependency 'rack-plastic', '>= 0.0.3'
+    s.version       = "0.1.0"
+    s.add_dependency 'rack-plastic', '>= 0.1.1'
     s.author        = "Wyatt Greene"
     s.email         = "techiferous@gmail.com"
     s.summary       = "Rack middleware wrapper for gsub."
@@ -29,5 +40,5 @@ begin
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end

data/lib/rack-gsub.rb CHANGED

@@ -5,7 +5,7 @@ module Rack
     def change_nokogiri_doc(doc)
       doc.at_css("body").traverse do |node|
-        if node.text?
+        if node.text? && node.parent.name != 'textarea' && node.parent.name != 'option'
           options.each do |pattern, replacement|
             update_text(node, node.content.gsub(pattern, replacement))
           end

data/test/gsub_test.rb ADDED

@@ -0,0 +1,197 @@
+require 'test/test_helper'
+class GsubTest < Test::Unit::TestCase
+  def test_no_arguments
+    before_html = %Q{
+      <!DOCTYPE html
+      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <title>Testing Rack::Gsub</title>
+        </head>
+        <body>
+          Hi, Mom!
+        </body>
+      </html>
+    }
+    after_html = process_html(before_html, Rack::Gsub)
+    assert_html_equal before_html, after_html
+  end
+  def test_basic_replace
+    before_html = %Q{
+      <!DOCTYPE html
+      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <title>Testing Rack::Gsub</title>
+        </head>
+        <body>
+          In Soviet Russia, there is censorship.
+        </body>
+      </html>
+    }
+    expected_html = %Q{
+      <!DOCTYPE html
+      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <title>Testing Rack::Gsub</title>
+        </head>
+        <body>
+          In Soviet Russia, there is no censorship.
+        </body>
+      </html>
+    }
+    after_html = process_html(before_html, Rack::Gsub, "censorship" => "no censorship")
+    assert_html_equal expected_html, after_html
+  end
+  def test_multiple_replace
+    before_html = %Q{
+      <!DOCTYPE html
+      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <title>Testing Rack::Gsub</title>
+        </head>
+        <body>
+          In Soviet Russia, there is censorship.
+        </body>
+      </html>
+    }
+    expected_html = %Q{
+      <!DOCTYPE html
+      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <title>Testing Rack::Gsub</title>
+        </head>
+        <body>
+          In SovXXt RussXa, thXrX Xs cXnsorshXp.
+        </body>
+      </html>
+    }
+    after_html = process_html(before_html, Rack::Gsub, "i" => "X", "e" => "X")
+    assert_html_equal expected_html, after_html
+  end
+  def test_regex_replace
+    before_html = %Q{
+      <!DOCTYPE html
+      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <title>Testing Rack::Gsub</title>
+        </head>
+        <body>
+          I'm getting better!
+          No, you're not.  You'll be stone dead in a moment.
+          Oh, I can't take him like that; it's against regulations.
+          I don't want to go in the cart!
+          Oh, don't be such a baby.
+          I can't take him...
+          I feel fine!
+        </body>
+      </html>
+    }
+    expected_html = %Q{
+      <!DOCTYPE html
+      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <title>Testing Rack::Gsub</title>
+        </head>
+        <body>
+          I'm getting better!
+          No, you're not.  You'll be stone dead in a moment.
+          Oh, I can't take him like th**; it's against regul**ions.
+          I don't want to go in the c**t!
+          Oh, don't be such a baby.
+          I can't take him...
+          I feel fine!
+        </body>
+      </html>
+    }
+    after_html = process_html(before_html, Rack::Gsub, /a[t,r]/ => '**')
+    assert_html_equal expected_html, after_html
+  end
+  def test_case_insensitive_regex_replace
+    before_html = %Q{
+      <!DOCTYPE html
+      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <title>Testing Rack::Gsub</title>
+        </head>
+        <body>
+          one ONE One
+          two TWO Two
+          three THREE Three
+          four FOUR Four
+        </body>
+      </html>
+    }
+    expected_html = %Q{
+      <!DOCTYPE html
+      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <title>Testing Rack::Gsub</title>
+        </head>
+        <body>
+          1 ONE One
+          two TWO Two
+          3 3 3
+          four FOUR Four
+        </body>
+      </html>
+    }
+    after_html = process_html(before_html, Rack::Gsub, /one/ => '1', /three/i => '3')
+    assert_html_equal expected_html, after_html
+  end
+  def test_form_elements_not_replaced
+    before_html = %Q{
+      <html>
+        <head><title>Testing Rack::Gsub</title></head>
+        <body>
+          <div id="container">
+            <p>
+              The contents of form elements should not be replaced by default.
+              <form action="/users/signup" class="signup_new_user" id="foo" method="post">
+                <input id="user_name" name="user[name]" size="80" tabindex="1" type="text"
+                       value="This should not be replaced.">
+                <select id="subscription_id" name="subscription_id" tabindex="2">
+                  <option value="1" selected>This should not be replaced.</option>
+                  <option value="2">This also should not be replaced.</option>
+                </select>
+                <textarea cols="20" id="commitment_note" name="commitment[note]" rows="10" tabindex="18">
+                  This should not be replaced.
+                </textarea>
+                <div class="actions">
+                  <input id="user_submit" name="commit" tabindex="3" type="submit"
+                         value="This should not be replaced.">
+                </div>
+              </form>
+            </p>
+          </div>
+        </body>
+      </html>
+    }
+    after_html = process_html(before_html, Rack::Gsub, 'This' => '!!!')
+    assert_html_equal before_html, after_html
+  end
+end

data/test/test_helper.rb ADDED

@@ -0,0 +1,15 @@
+require 'test/unit'
+require 'rubygems'
+require 'redgreen'
+require 'rack-gsub'
+require 'plastic_test_helper'
+module Test
+  module Unit
+    class TestCase
+      include PlasticTestHelper
+    end
+  end
+end

metadata CHANGED

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rack-gsub
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  hash: 27
+  prerelease: false
+  segments:
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors:
 - Wyatt Greene
@@ -9,19 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-12-03 00:00:00 -05:00
+date: 2010-07-18 00:00:00 -04:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-plastic
-  type: :runtime
-  version_requirement:
-  version_requirements: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
-    version:
+        hash: 25
+        segments:
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id001
 description: "\n      This is a Rack middleware wrapper for gsub. You can replace text on your\n      web page without worrying about accidentally modifying the HTML tags\n      themselves.\n    "
 email: techiferous@gmail.com
 executables: []
@@ -37,8 +49,10 @@ files:
 - README.rdoc
 - Rakefile
 - lib/rack-gsub.rb
+- test/gsub_test.rb
 - test/rackapp/app.rb
 - test/rackapp/config.ru
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/techiferous/rack-gsub
 licenses: []
@@ -49,23 +63,31 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
       version: "0"
-  version:
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
       version: "0"
-  version:
 requirements:
 - none
 rubyforge_project:
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key:
 specification_version: 3
 summary: Rack middleware wrapper for gsub.
 test_files:
+- test/gsub_test.rb
 - test/rackapp/app.rb
+- test/test_helper.rb