rewritten 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,12 +1,12 @@
 = Rewritten 
 
 Rewritten is a lookup-based rewriting engine that rewrites requested
-URLs on the fly. The URL manipulations depend on a translations found in
+URLs on the fly. The URL manipulations depend on translations found in
 a redis database.
 
-If a matching translation is found, the result is either a redirection
-to another translation or a modification of path and request parameters.
-If there is no matching translation, the request is left unmodified.
+If a matching translation is found, the result of a request is either a
+redirection or a modification of path and request parameters. For URLs
+without translation entries the request is left unmodified.
 
 Rewritten takes larges parts from the Resque codebase (which rocks). The
 gem is compromised of four parts:
@@ -14,9 +14,19 @@ gem is compromised of four parts:
 1. A Ruby library for creating, modifying and querying translations
 2. A Sinatra app for displaying and managing translations
 3. A Rack app for rewriting and redirecting request (Rack::Rewritten::Url)
-4. A Rack app for substituting URLs in HTML pages with their current translation (Rack::Rewritten:Html)
+4. A Rack app for substituting URLs in HTML pages with their current translation (Rack::Rewritten::Html)
 5. A Rack app for recording successful request (Rack::Rewritten::Record)
 
+
+== New Relic Notice
+
+There seem to be unresolved issues when Rack::Rewritten::Html is used
+in conjunction with the New Relic gem (being a rack app as well).
+Unfortunately the only workaround so far is either disabling New Relic
+or Rack::Rewritten::Html (pointers in the right debugging direction or
+pull requests are welcome).
+
+
 == Overview
 
 The Rewritten library allows you to create new URL translations and     
@@ -33,18 +43,25 @@ Translations are removed in a similar fashion.
 
 == Usage in your Rack stack
 
+To take full advantage of the engine you would use both, the URL and
+HTML, rack apps as follows:
+
     use Rack::Rewritten::Url
     use Rack::Rewritten::Html
     run Your::App
 
+This way the URL rewriting and generation is stays decoupled from your
+app. For a Rails app, for instance, you wouldn't need to mess with your
+<tt>routes.rb</tt> or path helpers when dealing with custom URLs.
+
 
 == The Front End
 
 Rewritten comes with a Sinatra-based front end for dislaying and
-managing your URL translations (in the familiar Resque design).
+managing your URL translations (in the familiar Resque layout).
 
+[IMAGE]
 
-[PICTURE]
 
 === Standalone
 
@@ -65,7 +82,8 @@ run Rack::URLMap.new \
     "/"       => Your::App.new,
     "/resque" => Rewritten::Server.new
     
-Check examples/demo/config.ru for a functional example (including HTTP basic auth).
+Check lib/test.ru for a functional example.
+
 
 
 

data/lib/rewritten/server/views/new.erb

@@ -4,7 +4,7 @@
 
 
 <div style="float: left; margin-top: 10px">
-<form method="POST" action="<%= u "/mappings" %>">
+<form method="POST" action="<%= u "/translations" %>">
   <label>From:</label><br/>  <input type="text" name="from" /> <br />
   <label>To:</label><br/>   <input type="text" name="to" value="<%= params[:to] %>" /> <br />
   <input type="submit" value="Create" />

data/lib/rewritten/server/views/to.erb

@@ -1,7 +1,7 @@
 
 <h1 class='wi'><%= params[:to] %> (App URL)</h1>
 
-<a href="<%= u(%|/new?to=#{params[:to]}|) %>"> + add Another translation </a>
+<a href="<%= u(%|/new?to=#{params[:to]}|) %>"> + add another translation </a>
 
 <table class='queues'>
   <tr>

data/lib/rewritten/server/views/{mappings.erb → translations.erb}

@@ -32,15 +32,15 @@
 
   <h1 class='wi'>Translations</h1>
 
-  <p class='intro'>The list below contains all the registered translations from
-  url to target url.  Select a target from above to view all mappings for the
-  target.</p>
+  <p class='intro'>The list below contains all the registered translations from an 
+  url to target url.  To view all translations for a target click on the
+  target URL.</p>
 
-  <a href="<%= u('/new') %>"> + New Mapping </a>
+  <a href="<%= u('/new') %>"> + New Translation </a>
 
   <p class='sub'>Showing <%= (start = params[:start].to_i)+1 %> to <%= start + Rewritten.per_page %> of <b><%=size = Rewritten.size('froms')%></b> translations. </p>
 
-  <table class='queues'>
+  <table class=''>
     <tr>
       <th>from URL (Browser Location)</th>
       <th>to URL (Your App)</th>
@@ -49,7 +49,7 @@
     <% for mapping in Rewritten.list_range("froms", params[:start].to_i, Rewritten.per_page) %>
       <tr>
         <td class=''><a href="<%= mapping %>" target="new"><%= mapping %></td>
-        <td class='queue'><a href="<%= u("/to?to=#{to=Rewritten.redis.get("from:#{mapping}")}") %>"><%= to %></td>
+        <td class=''><a href="<%= u("/to?to=#{to=Rewritten.redis.get("from:#{mapping}")}") %>"><%= to %></td>
         </tr>
       <% end %>
 

data/lib/rewritten/server.rb

@@ -139,21 +139,21 @@ module Rewritten
 
 
     get "/?" do
-      redirect url_path(:overview)
+      redirect url_path(:translations)
     end
 
-    get "/overview" do
-      show 'overview'
+    get "/translations" do
+      show 'translations'
     end
 
     get "/new" do 
       show "new"
     end
 
-    post "/mappings" do
+    post "/translations" do
       if params[:from]!='' && params[:to]!=''
         Rewritten.add_translation(params[:from], params[:to])
-        redirect u('overview')
+        redirect u('translations')
       else
         show "new"
       end
@@ -200,7 +200,7 @@ module Rewritten
 
     def self.tabs
       #@tabs ||= ["Overview", "Working", "Failed", "Queues", "Workers", "Stats"]
-      @tabs ||= ["Overview", "Hits"] 
+      @tabs ||= ["Translations", "Hits"] 
     end
  
   end

data/lib/rewritten/version.rb

@@ -1,3 +1,3 @@
 module Rewritten
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/rewritten.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Kai Rubarth"]
   s.email       = ["kai@doxter.de"]
   s.homepage    = ""
-  s.summary     = %q{Rack app that rewrites URLs -- nicely and uncomplicated}
+  s.summary     = %q{A redis-based URL rewriting engine}
 
   s.rubyforge_project = "rewritten"
 
@@ -23,16 +23,22 @@ Gem::Specification.new do |s|
   s.add_dependency "multi_json",      "~> 1.0"
 
   s.description = <<description
-    Rewritten is a simple Redis-backed Ruby library that facilitates creating and refactoring 
-    arbitrary urls in your Rack applications.
-
-    Rewritten is inspired by the awesome Resque and Rack::Rewrite gems. It is
-    compromised of four parts:
-
-    * A Ruby library for creating and modifying URLs for resources 
-    * A Rack app that takes care of redirecting old URLS in a SEO friendly matter
-    * A Rack app that rewrites links to their nice counterpart 
-    * A Sinatra app for managing URLs 
+    Rewritten is a lookup-based rewriting engine that rewrites requested
+    URLs on the fly. The URL manipulations depend on translations found in
+    a redis database.
+
+    If a matching translation is found, the result of a request is either a
+    redirection or a modification of path and request parameters. For URLs
+    without translation entries the request is left unmodified.
+
+    Rewritten takes larges parts from the Resque codebase (which rocks). The
+    gem is compromised of four parts:
+
+    1. A Ruby library for creating, modifying and querying translations
+    2. A Sinatra app for displaying and managing translations
+    3. A Rack app for rewriting and redirecting request (Rack::Rewritten::Url)
+    4. A Rack app for substituting URLs in HTML pages with their current translation (Rack::Rewritten::Html)
+    5. A Rack app for recording successful request (Rack::Rewritten::Record)
 description
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rewritten
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Kai Rubarth
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-26 00:00:00 +02:00
+date: 2011-09-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,7 +81,7 @@ dependencies:
         version: "1.0"
   type: :runtime
   version_requirements: *id004
-description: "    Rewritten is a simple Redis-backed Ruby library that facilitates creating and refactoring \n    arbitrary urls in your Rack applications.\n\n    Rewritten is inspired by the awesome Resque and Rack::Rewrite gems. It is\n    compromised of four parts:\n\n    * A Ruby library for creating and modifying URLs for resources \n    * A Rack app that takes care of redirecting old URLS in a SEO friendly matter\n    * A Rack app that rewrites links to their nice counterpart \n    * A Sinatra app for managing URLs \n"
+description: "    Rewritten is a lookup-based rewriting engine that rewrites requested\n    URLs on the fly. The URL manipulations depend on translations found in\n    a redis database.\n\n    If a matching translation is found, the result of a request is either a\n    redirection or a modification of path and request parameters. For URLs\n    without translation entries the request is left unmodified.\n\n    Rewritten takes larges parts from the Resque codebase (which rocks). The\n    gem is compromised of four parts:\n\n    1. A Ruby library for creating, modifying and querying translations\n    2. A Sinatra app for displaying and managing translations\n    3. A Rack app for rewriting and redirecting request (Rack::Rewritten::Url)\n    4. A Rack app for substituting URLs in HTML pages with their current translation (Rack::Rewritten::Html)\n    5. A Rack app for recording successful request (Rack::Rewritten::Record)\n"
 email: 
 - kai@doxter.de
 executables: 
@@ -123,13 +123,13 @@ files:
 - lib/rewritten/server/views/key_sets.erb
 - lib/rewritten/server/views/key_string.erb
 - lib/rewritten/server/views/layout.erb
-- lib/rewritten/server/views/mappings.erb
 - lib/rewritten/server/views/new.erb
 - lib/rewritten/server/views/next_more.erb
 - lib/rewritten/server/views/overview.erb
 - lib/rewritten/server/views/queues.erb
 - lib/rewritten/server/views/stats.erb
 - lib/rewritten/server/views/to.erb
+- lib/rewritten/server/views/translations.erb
 - lib/rewritten/server/views/workers.erb
 - lib/rewritten/server/views/working.erb
 - lib/rewritten/version.rb
@@ -169,6 +169,6 @@ rubyforge_project: rewritten
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Rack app that rewrites URLs -- nicely and uncomplicated
+summary: A redis-based URL rewriting engine
 test_files: []