rack-rewrite 1.4.01 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed55c2a3e47528ab894d96863ec12c7de6120ac1
-  data.tar.gz: 4cab5d9ce803a7ecf29a946cc7ed84938f865571
+  metadata.gz: 9b433927615a0c3d699ee348e2442d5e2d3f3bed
+  data.tar.gz: 8b8f88d6bd02f4149e37a7d3956045fa795a467f
 SHA512:
-  metadata.gz: 9f00621feb515eb4fcf4c99b9e0d7451c1027f55b288cd7c379adc3f86ac1b0ecfc85d62f386a7dfbca679c615da468363894b79cfa945105d264fc64cb63b02
-  data.tar.gz: ab5b10d820d422f5fae80616a94746c9587049f5a89bce9b5e715995e0343a98c356089806d0227c83a3530e5eebe0661bc62ebf6a2f8bbd70aed4b405986d03
+  metadata.gz: cfd596b1093d843050fe96bf3d6737c821d20a10d3371b17dc23a70c28e78cb55ddbeebe059f8842ad976170426c8cba5da8e215e21cd175165c7794c1dedd23
+  data.tar.gz: 45b9edc5712be185b07cbcbc81dceab6e0053370510c2c381f3ba95f10b72e0aaed2708cfb2cf4cbfe0d4ce6ac4734bd8741f2fd2f1cc1baa8bb53e414a52192

data/History.rdoc

@@ -1,3 +1,7 @@
+== 1.4.1 / 2013-11-07
+* API
+  * Add support for external loaders (#50)
+
 === 1.4.01 / 2013-09-13
 * API
   * Add support for lambda matchers

data/README.markdown

@@ -14,6 +14,7 @@ can get away with rack-rewrite instead of writing Apache mod_rewrite rules.
 ### Sample rackup file
 
 ```ruby
+# config.ru
 gem 'rack-rewrite', '~> 1.2.1'
 require 'rack/rewrite'
 use Rack::Rewrite do
@@ -27,6 +28,7 @@ end
 ### Sample usage in a rails app
 
 ```ruby
+# config/application.rb
 config.middleware.insert_before(Rack::Lock, Rack::Rewrite) do
   rewrite   '/wiki/John_Trupiano',  '/john'
   r301      '/wiki/Yair_Flicker',   '/yair'
@@ -35,8 +37,23 @@ config.middleware.insert_before(Rack::Lock, Rack::Rewrite) do
 end
 ```
 
-Note: when using `config.threadsafe!` (default in Rails 4), you'll need to use `Rack::Runtime` instead of `Rack::Lock`.
+If you use `config.threadsafe`, you'll need to `insert_before(Rack::Runtime, Rack::Rewrite)` as `Rack::Lock` does
+not exist when `config.allow_concurrency == true`:
 
+```ruby
+config.middleware.insert_before(Rack::Runtime, Rack::Rewrite) do
+  rewrite   '/wiki/John_Trupiano',  '/john'
+  r301      '/wiki/Yair_Flicker',   '/yair'
+  r302      '/wiki/Greg_Jastrab',   '/greg'
+  r301      %r{/wiki/(\w+)_\w+},    '/$1'
+end
+```
+
+Or insert Rack::Rewrite to the top of the stack:
+
+``` ruby
+config.middleware.insert 0, 'Rack::Rewrite' {}
+```
 
 ## Redirection codes
 
@@ -200,9 +217,9 @@ Recall that rules are interpreted from top to bottom.  So you can install
 "default" rewrite rules if you like.  [2] is a sample default rule that
 will redirect all other requests to the wiki to a google search.
 
-### :send_file, :x_send_file
+### :send_file, :x_send_file, :send_data
 
-Calls to #send_file and #x_send_file also have the same signature as #rewrite.
+Calls to #send_file and #x_send_file and #send_data also have the same signature as #rewrite.
 If the rule matches, the 'to' parameter is interpreted as a path to a file
 to be rendered instead of passing the application call up the rack stack.
 
@@ -213,6 +230,9 @@ send_file /*/, 'public/spammers.htm', :if => Proc.new { |rack_env|
 x_send_file /^blog\/.*/, 'public/blog_offline.htm', :if => Proc.new { |rack_env|
   File.exists?('public/blog_offline.htm')
 }
+send_data /^blog\/.*/, 'public/blog_offline.png', :if => Proc.new { |rack_env|
+  File.exists?('public/blog_offline.htm')
+}
 ```
 
 ## Options Parameter
@@ -308,7 +328,7 @@ This will not match the relative URL /features but would match /features.xml.
 
 ### Keeping your querystring
 
-When rewriting a URL, you may want to keep your querystring in tact (for
+When rewriting a URL, you may want to keep your querystring intact (for
 example if you're tracking traffic sources).  You will need to include a
 capture group and substitution pattern in your rewrite rule to achieve this.
 
@@ -338,6 +358,33 @@ string to /today.html
   r301 lambda { "/#{Time.current.strftime(%m%d%Y)}.html" }, '/today.html'
 ```
 
+
+##Alternative loaders
+
+rack-rewrite can also be driven by external loaders. Bundled with this library is a loader for YAML files.
+
+```
+config.middleware.insert_before(Rack::Lock, Rack::Rewrite,
+    :klass => Rack::Rewrite::YamlRuleSet,
+    :options => {:file_name => @file_name})
+```
+
+Using syntax like
+
+```
+-
+    method: r301
+    from: !ruby/regexp '/(.*)/print'
+    to : '$1/printer_friendly'
+    options :
+        host : 'example.com'
+```
+
+Any class can be used here as long as:
+
+  - the class take an options hash
+  -  `#rules` returns an array of `Rack::Rewrite::Rule` instances
+
 ## Contribute
 
 rack-rewrite is maintained by [@travisjeffery](http://github.com/travisjeffery).

data/VERSION

@@ -1 +1 @@
-1.4.01
+1.5.0

data/lib/rack/rewrite.rb

@@ -5,9 +5,13 @@ module Rack
   # A rack middleware for defining and applying rewrite rules. In many cases you 
   # can get away with rack-rewrite instead of writing Apache mod_rewrite rules.  
   class Rewrite
-    def initialize(app, &rule_block)
+    def initialize(app, given_options = {}, &rule_block)
+      options = {
+          :klass => RuleSet,
+          :options => {}
+      }.merge(given_options)
       @app = app
-      @rule_set = RuleSet.new
+      @rule_set = options[:klass].new(options[:options])
       @rule_set.instance_eval(&rule_block) if block_given?
     end
     

data/lib/rack/rewrite/rule.rb

@@ -4,7 +4,7 @@ module Rack
   class Rewrite
     class RuleSet
       attr_reader :rules
-      def initialize #:nodoc:
+      def initialize(options = {})#:nodoc:
         @rules = []
       end
 
@@ -90,6 +90,13 @@ module Rack
           add_rule :x_send_file, *args
         end
 
+        # Creates a rule taht will render the raw data if matched
+        #  send_data /*/, 'public/system/maintenance.html',
+        #    :if => Proc.new { File.exists?('public/system/maintenance.html') }
+        def send_data(*args)
+          add_rule :send_data, *args
+        end
+
       private
         def add_rule(method, from, to, options = {}) #:nodoc:
           @rules << Rule.new(method.to_sym, from, to, options)
@@ -160,6 +167,11 @@ module Rack
             'Content-Length' => ::File.size(interpreted_to).to_s,
             'Content-Type'   => Rack::Mime.mime_type(::File.extname(interpreted_to))
             }.merge!(additional_headers), []]
+        when :send_data
+          [status, {
+            'Content-Type' => interpreted_to.bytesize,
+            'Content-Type' => 'text/html',
+          }.merge!(additional_headers), [interpreted_to]]
         else
           raise Exception.new("Unsupported rule: #{self.rule_type}")
         end

data/test/test_helper.rb

@@ -8,6 +8,11 @@ require 'test/unit'
 class Test::Unit::TestCase
 end
 
+def rack_env_for(url, options = {})
+  components = url.split('?')
+  {'PATH_INFO' => components[0], 'QUERY_STRING' => components[1] || ''}.merge(options)
+end
+
 def supported_status_codes
   [:r301, :r302, :r303, :r307]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-rewrite
 version: !ruby/object:Gem::Version
-  version: 1.4.01
+  version: 1.5.0
 platform: ruby
 authors:
 - Travis Jeffery
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-13 00:00:00.000000000 Z
+date: 2014-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler