Add rubocop + fix all styling issues

Author: waterlink

.rubocop.yml

@@ -0,0 +1,15 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/LineLength:
+  Max: 100
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+#begin ruby 1.8 support
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/Lambda:
+  Enabled: false

Gemfile

@@ -6,6 +6,7 @@ group :test do
   gem "rspec"
   gem "rack-test"
   gem "webmock"
+  gem "rubocop"
 end
 
 group :development, :test do

Rakefile

@@ -1,10 +1,10 @@
-require 'rubygems'
-require 'rake'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "rubygems"
+require "rake"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+  spec.pattern = "spec/**/*_spec.rb"
 end
 
 task :default => :spec

lib/rack/reverse_proxy.rb

@@ -1,5 +1,6 @@
 require "rack_reverse_proxy"
 
+# Re-opening Rack module only to define ReverseProxy constant
 module Rack
   ReverseProxy = RackReverseProxy::Middleware
 end

lib/rack_reverse_proxy.rb

@@ -1,3 +1,8 @@
+require "rack_reverse_proxy/version"
 require "rack_reverse_proxy/errors"
 require "rack_reverse_proxy/matcher"
 require "rack_reverse_proxy/middleware"
+
+# A Reverse Proxy for Rack
+module RackReverseProxy
+end

lib/rack_reverse_proxy/errors.rb

@@ -1,5 +1,6 @@
 module RackReverseProxy
   module Errors
+    # GenericURI indicates that url is too generic
     class GenericURI < Exception
       attr_reader :url
 
@@ -8,25 +9,27 @@ def intialize(url)
       end
 
       def to_s
-        %Q(Your URL "#{@url}" is too generic. Did you mean "http://#{@url}"?)
+        %(Your URL "#{@url}" is too generic. Did you mean "http://#{@url}"?)
       end
     end
 
+    # AmbiguousMatch indicates that path matched more than one endpoint
     class AmbiguousMatch < Exception
       attr_reader :path, :matches
+
       def initialize(path, matches)
         @path = path
         @matches = matches
       end
 
       def to_s
-        %Q(Path "#{path}" matched multiple endpoints: #{formatted_matches})
+        %(Path "#{path}" matched multiple endpoints: #{formatted_matches})
       end
 
       private
 
       def formatted_matches
-        matches.map {|matcher| matcher.to_s}.join(', ')
+        matches.map(&:to_s).join(", ")
       end
     end
   end

lib/rack_reverse_proxy/matcher.rb

@@ -1,41 +1,47 @@
 module RackReverseProxy
+  # FIXME: Enable them and fix issues during refactoring
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+
+  # Matcher understands if specific url matches encapsulated rule or not
   class Matcher
-    def initialize(matcher, url=nil, options={})
-      @default_url=url
-      @url=url
-      @options=options
+    def initialize(matcher, url = nil, options = {})
+      @default_url = url
+      @url = url
+      @options = options
 
-      if matcher.kind_of?(String)
-        @matcher = /^#{matcher.to_s}/
+      if matcher.is_a?(String)
+        @matcher = /^#{matcher}/
       elsif matcher.respond_to?(:match)
         @matcher = matcher
       else
-        raise "Invalid Matcher for reverse_proxy"
+        fail ArgumentError, "Invalid Matcher for reverse_proxy"
       end
     end
 
-    attr_reader :matcher,:url, :default_url,:options
+    attr_reader :matcher, :url, :default_url, :options
 
     def match?(path, *args)
       match_path(path, *args) ? true : false
     end
 
-    def get_uri(path,env)
+    def get_uri(path, env)
       return nil if url.nil?
-      _url=(url.respond_to?(:call) ? url.call(env) : url.clone)
-      if _url =~/\$\d/
-        match_path(path).to_a.each_with_index { |m, i| _url.gsub!("$#{i.to_s}", m) }
-        URI(_url)
+      realized_url = (url.respond_to?(:call) ? url.call(env) : url.clone)
+      if realized_url =~ /\$\d/
+        match_path(path).to_a.each_with_index { |m, i| realized_url.gsub!("$#{i}", m) }
+        URI(realized_url)
       else
-        default_url.nil? ? URI.parse(_url) : URI.join(_url, path)
+        default_url.nil? ? URI.parse(realized_url) : URI.join(realized_url, path)
       end
     end
 
     def to_s
-      %Q("#{matcher.to_s}" => "#{url}")
+      %("#{matcher}" => "#{url}")
     end
 
     private
+
     def match_path(path, *args)
       headers = args[0]
       rackreq = args[1]

lib/rack_reverse_proxy/middleware.rb

@@ -1,25 +1,44 @@
-require 'net/http'
-require 'net/https'
+require "net/http"
+require "net/https"
 require "rack-proxy"
 
 module RackReverseProxy
+  # FIXME: Enable them and fix issues during refactoring
+  # rubocop:disable Metrics/ClassLength
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
+  # rubocop:disable Metrics/AbcSize
+
+  # Rack middleware for handling reverse proxying
   class Middleware
     include NewRelic::Agent::Instrumentation::ControllerInstrumentation if defined? NewRelic
 
     def initialize(app = nil, &b)
-      @app = app || lambda {|env| [404, [], []] }
+      @app = app || lambda { |_| [404, [], []] }
       @matchers = []
-      @global_options = {:preserve_host => true, :x_forwarded_host => true, :matching => :all, :replace_response_host => false}
+      @global_options = {
+        :preserve_host => true,
+        :x_forwarded_host => true,
+        :matching => :all,
+        :replace_response_host => false,
+      }
       instance_eval(&b) if block_given?
     end
 
     def call(env)
       rackreq = Rack::Request.new(env)
-      matcher = get_matcher(rackreq.fullpath, Rack::Proxy.extract_http_request_headers(rackreq.env), rackreq)
+      matcher = get_matcher(
+        rackreq.fullpath,
+        Rack::Proxy.extract_http_request_headers(rackreq.env),
+        rackreq,
+      )
       return @app.call(env) if matcher.nil?
 
       if @global_options[:newrelic_instrumentation]
-        action_name = "#{rackreq.path.gsub(/\/\d+/,'/:id').gsub(/^\//,'')}/#{rackreq.request_method}" # Rack::ReverseProxy/foo/bar#GET
+        # 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)
         end
@@ -31,40 +50,43 @@ def call(env)
     private
 
     def proxy(env, source_request, matcher)
-      uri = matcher.get_uri(source_request.fullpath,env)
-      if uri.nil?
-        return @app.call(env)
-      end
+      uri = matcher.get_uri(source_request.fullpath, env)
+      return @app.call(env) if uri.nil?
+
       options = @global_options.dup.merge(matcher.options)
 
       # Initialize request
-      target_request = Net::HTTP.const_get(source_request.request_method.capitalize).new(uri.request_uri)
+      target_request = Net::HTTP.const_get(
+        source_request.request_method.capitalize,
+      ).new(uri.request_uri)
 
       # Setup headers
       target_request_headers = Rack::Proxy.extract_http_request_headers(source_request.env)
 
       if options[:preserve_host]
         if uri.port == uri.default_port
-          target_request_headers['HOST'] = uri.host
+          target_request_headers["HOST"] = uri.host
         else
-          target_request_headers['HOST'] = "#{uri.host}:#{uri.port}"
+          target_request_headers["HOST"] = "#{uri.host}:#{uri.port}"
         end
       end
 
       if options[:x_forwarded_host]
-        target_request_headers['X-Forwarded-Host'] = source_request.host
-        target_request_headers['X-Forwarded-Port'] = "#{source_request.port}"
+        target_request_headers["X-Forwarded-Host"] = source_request.host
+        target_request_headers["X-Forwarded-Port"] = "#{source_request.port}"
       end
 
       target_request.initialize_http_header(target_request_headers)
 
       # Basic auth
-      target_request.basic_auth options[:username], options[:password] if options[:username] and options[:password]
+      if options[:username] && options[:password]
+        target_request.basic_auth options[:username], options[:password]
+      end
 
       # Setup body
       if target_request.request_body_permitted? && source_request.body
         source_request.body.rewind
-        target_request.body_stream    = source_request.body
+        target_request.body_stream = source_request.body
       end
 
       target_request.content_length = source_request.content_length || 0
@@ -79,16 +101,18 @@ def proxy(env, source_request, matcher)
       target_response.use_ssl = "https" == uri.scheme
 
       # Let rack set the transfer-encoding header
-      response_headers = Rack::Utils::HeaderHash.new Rack::Proxy.normalize_headers(format_headers(target_response.headers))
-      response_headers.delete('Transfer-Encoding')
-      response_headers.delete('Status')
+      response_headers = Rack::Utils::HeaderHash.new(
+        Rack::Proxy.normalize_headers(format_headers(target_response.headers)),
+      )
+      response_headers.delete("Transfer-Encoding")
+      response_headers.delete("Status")
 
       # Replace the location header with the proxy domain
-      if response_headers['Location'] && options[:replace_response_host]
-        response_location = URI(response_headers['location'])
+      if response_headers["Location"] && options[:replace_response_host]
+        response_location = URI(response_headers["location"])
         response_location.host = source_request.host
         response_location.port = source_request.port
-        response_headers['Location'] = response_location.to_s
+        response_headers["Location"] = response_location.to_s
       end
 
       [target_response.status, response_headers, target_response.body]
@@ -102,26 +126,27 @@ def get_matcher(path, headers, rackreq)
       if matches.length < 1
         nil
       elsif matches.length > 1 && @global_options[:matching] != :first
-        raise Errors::AmbiguousMatch.new(path, matches)
+        fail Errors::AmbiguousMatch.new(path, matches)
       else
         matches.first
       end
     end
 
     def reverse_proxy_options(options)
-      @global_options=options
+      @global_options = options
     end
 
-    def reverse_proxy(matcher, url=nil, opts={})
-      raise Errors::GenericURI.new(url) if matcher.is_a?(String) && url.is_a?(String) && URI(url).class == URI::Generic
-      @matchers << Matcher.new(matcher,url,opts)
+    def reverse_proxy(matcher, url = nil, opts = {})
+      if matcher.is_a?(String) && url.is_a?(String) && URI(url).class == URI::Generic
+        fail Errors::GenericURI.new, url
+      end
+      @matchers << Matcher.new(matcher, url, opts)
     end
 
     def format_headers(headers)
-      headers.reduce({}) do |acc, (key, val)|
-        formated_key = key.split('-').map(&:capitalize).join('-')
+      headers.each_with_object({}) do |(key, val), acc|
+        formated_key = key.split("-").map(&:capitalize).join("-")
         acc[formated_key] = Array(val)
-        acc
       end
     end
   end

lib/rack_reverse_proxy/version.rb

@@ -1,3 +1,4 @@
+#:nodoc:
 module RackReverseProxy
   VERSION = "0.9.1"
 end

rack-reverse-proxy.gemspec

@@ -1,14 +1,31 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rack_reverse_proxy/version'
+require "rack_reverse_proxy/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "rack-reverse-proxy"
   spec.version       = RackReverseProxy::VERSION
-  spec.authors       = ["Jon Swope", "Ian Ehlert", "Roman Ernst", "Oleksii Fedorov"]
-  spec.email         = ["[email protected]", "[email protected]", "[email protected]", "[email protected]"]
-  spec.summary       = %q{A Simple Reverse Proxy for Rack}
-  spec.description   = %q{A Rack based reverse proxy for basic needs.  Useful for testing or in cases where webserver configuration is unavailable.}
+
+  spec.authors = [
+    "Jon Swope",
+    "Ian Ehlert",
+    "Roman Ernst",
+    "Oleksii Fedorov",
+  ]
+
+  spec.email = [
+    "[email protected]",
+    "[email protected]",
+    "[email protected]",
+    "[email protected]",
+  ]
+
+  spec.summary       = "A Simple Reverse Proxy for Rack"
+  spec.description   = <<eos
+A Rack based reverse proxy for basic needs.
+Useful for testing or in cases where webserver configuration is unavailable.
+eos
+
   spec.homepage      = "https://github.com/waterlink/rack-reverse-proxy"
   spec.license       = "MIT"