Rename Matcher -> Rule

waterlink · waterlink · commit 2eb01ecb1f6f · 2015-08-26T01:19:48.000+03:00
diff --git a/README.md b/README.md
@@ -17,9 +17,10 @@ gem "rack-reverse-proxy", require: "rack/reverse_proxy"
 ```
 
 ## Usage
-Matchers can be a regex or a string. If a regex is used, you can use the subcaptures in your forwarding url by denoting them with a `$`.
 
-Right now if more than one matcher matches any given route, it throws an exception for an ambiguous match.  This will probably change later. If no match is found, the call is forwarded to your application.
+Rules can be a regex or a string. If a regex is used, you can use the subcaptures in your forwarding url by denoting them with a `$`.
+
+Right now if more than one rule matches any given route, it throws an exception for an ambiguous match.  This will probably change later. If no match is found, the call is forwarded to your application.
 
 Below is an example for configuring the middleware:
 
@@ -43,7 +44,8 @@ end
 run app
 ```
 
-reverse_proxy_options sets global options for all reverse proxies. Available options are:
+`reverse_proxy_options` sets global options for all reverse proxies. Available options are:
+
 * `:preserve_host` Set to false to omit Host headers
 * `:username` username for basic auth
 * `:password` password for basic auth
diff --git a/lib/rack_reverse_proxy/matcher.rb b/lib/rack_reverse_proxy/matcher.rb
@@ -3,8 +3,8 @@ module RackReverseProxy
   # rubocop:disable Metrics/MethodLength
   # rubocop:disable Metrics/AbcSize
 
-  # Matcher understands if specific url matches encapsulated rule or not
-  class Matcher
+  # Rule understands which urls need to be proxied
+  class Rule
     def initialize(matcher, url = nil, options = {})
       @default_url = url
       @url = url
@@ -15,13 +15,13 @@ def initialize(matcher, url = nil, options = {})
       elsif matcher.respond_to?(:match)
         @matcher = matcher
       else
-        fail ArgumentError, "Invalid Matcher for reverse_proxy"
+        fail ArgumentError, "Invalid Rule for reverse_proxy"
       end
     end
 
     attr_reader :matcher, :url, :default_url, :options
 
-    def match?(path, *args)
+    def proxy?(path, *args)
       match_path(path, *args) ? true : false
     end
 
diff --git a/lib/rack_reverse_proxy/middleware.rb b/lib/rack_reverse_proxy/middleware.rb
@@ -16,7 +16,7 @@ class Middleware
 
     def initialize(app = nil, &b)
       @app = app || lambda { |_| [404, [], []] }
-      @matchers = []
+      @rules = []
       @global_options = {
         :preserve_host => true,
         :x_forwarded_host => true,
@@ -28,32 +28,32 @@ def initialize(app = nil, &b)
 
     def call(env)
       rackreq = Rack::Request.new(env)
-      matcher = get_matcher(
+      rule = get_rule(
         rackreq.fullpath,
         Rack::Proxy.extract_http_request_headers(rackreq.env),
         rackreq
       )
-      return @app.call(env) if matcher.nil?
+      return @app.call(env) if rule.nil?
 
       if @global_options[:newrelic_instrumentation]
         # Rack::ReverseProxy/foo/bar#GET
         action_path = rackreq.path.gsub(%r{/\d+}, "/:id").gsub(%r{^/}, "")
         action_name = "#{action_path}/#{rackreq.request_method}"
         perform_action_with_newrelic_trace(:name => action_name, :request => rackreq) do
-          proxy(env, rackreq, matcher)
+          proxy(env, rackreq, rule)
         end
       else
-        proxy(env, rackreq, matcher)
+        proxy(env, rackreq, rule)
       end
     end
 
     private
 
-    def proxy(env, source_request, matcher)
-      uri = matcher.get_uri(source_request.fullpath, env)
+    def proxy(env, source_request, rule)
+      uri = rule.get_uri(source_request.fullpath, env)
       return @app.call(env) if uri.nil?
 
-      options = @global_options.dup.merge(matcher.options)
+      options = @global_options.dup.merge(rule.options)
 
       # Initialize request
       target_request = Net::HTTP.const_get(
@@ -118,9 +118,9 @@ def proxy(env, source_request, matcher)
       [target_response.status, response_headers, target_response.body]
     end
 
-    def get_matcher(path, headers, rackreq)
-      matches = @matchers.select do |matcher|
-        matcher.match?(path, headers, rackreq)
+    def get_rule(path, headers, rackreq)
+      matches = @rules.select do |rule|
+        rule.proxy?(path, headers, rackreq)
       end
 
       if matches.length < 1
@@ -136,11 +136,11 @@ def reverse_proxy_options(options)
       @global_options = options
     end
 
-    def reverse_proxy(matcher, url = nil, opts = {})
-      if matcher.is_a?(String) && url.is_a?(String) && URI(url).class == URI::Generic
+    def reverse_proxy(rule, url = nil, opts = {})
+      if rule.is_a?(String) && url.is_a?(String) && URI(url).class == URI::Generic
         fail Errors::GenericURI.new, url
       end
-      @matchers << Matcher.new(matcher, url, opts)
+      @rules << Rule.new(rule, url, opts)
     end
 
     def format_headers(headers)
