From 5cc89da86431e019a9ce5139f7bcba7537995aa5 Mon Sep 17 00:00:00 2001 From: iMacTia Date: Tue, 26 Feb 2019 09:47:19 +0000 Subject: [PATCH 1/2] Fixes rubocop Style/HashSyntax issues. --- .rubocop_todo.yml | 11 +----- Gemfile | 16 ++++---- Rakefile | 4 +- lib/faraday/adapter.rb | 20 +++++----- lib/faraday/adapter/em_http.rb | 18 ++++----- .../adapter/em_synchrony/parallel_manager.rb | 8 ++-- lib/faraday/adapter/excon.rb | 18 ++++----- lib/faraday/adapter/httpclient.rb | 4 +- lib/faraday/adapter/patron.rb | 2 +- lib/faraday/autoload.rb | 38 +++++++++---------- lib/faraday/connection.rb | 12 +++--- lib/faraday/options/connection_options.rb | 2 +- lib/faraday/options/env.rb | 4 +- lib/faraday/options/proxy_options.rb | 4 +- lib/faraday/request.rb | 26 ++++++------- lib/faraday/response.rb | 8 ++-- lib/faraday/response/logger.rb | 2 +- lib/faraday/response/raise_error.rb | 2 +- script/proxy-server | 6 +-- script/server | 12 +++--- spec/faraday/connection_spec.rb | 14 +++---- spec/faraday/options/options_spec.rb | 2 +- spec/faraday/params_encoders/nested_spec.rb | 2 +- spec/faraday/request/url_encoded_spec.rb | 12 +++--- spec/support/streaming_response_checker.rb | 4 +- test/adapters/em_http_test.rb | 2 +- test/adapters/em_synchrony_test.rb | 2 +- test/adapters/integration.rb | 14 +++---- test/adapters/rack_test.rb | 2 +- 29 files changed, 132 insertions(+), 139 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 19d452d38..f1e4dd05d 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,6 +1,6 @@ # This configuration was generated by # `rubocop --auto-gen-config` -# on 2019-02-25 23:59:49 +0100 using RuboCop version 0.65.0. +# on 2019-02-26 09:45:16 +0000 using RuboCop version 0.65.0. # The point is for the user to remove these configuration records # one by one as the offenses are removed from the code base. # Note that changes in the inspected code, or installation of new @@ -554,13 +554,6 @@ Style/GuardClause: - 'lib/faraday/request/url_encoded.rb' - 'lib/faraday/utils/headers.rb' -# Offense count: 154 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols. -# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys -Style/HashSyntax: - Enabled: false - # Offense count: 1 Style/IfInsideElse: Exclude: @@ -957,7 +950,7 @@ Style/YodaCondition: - 'script/proxy-server' - 'test/helper.rb' -# Offense count: 279 +# Offense count: 273 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns. # URISchemes: http, https Metrics/LineLength: diff --git a/Gemfile b/Gemfile index 817d5b21e..1b08c0a6f 100644 --- a/Gemfile +++ b/Gemfile @@ -4,8 +4,8 @@ source 'https://rubygems.org' ruby RUBY_VERSION -gem 'ffi-ncurses', '~> 0.3', :platforms => :jruby -gem 'jruby-openssl', '~> 0.8.8', :platforms => :jruby +gem 'ffi-ncurses', '~> 0.3', platforms: :jruby +gem 'jruby-openssl', '~> 0.8.8', platforms: :jruby gem 'rake' group :development, :test do @@ -13,20 +13,20 @@ group :development, :test do end group :test do - gem 'coveralls', :require => false - gem 'em-http-request', '>= 1.1', :require => 'em-http' - gem 'em-synchrony', '>= 1.0.3', :require => ['em-synchrony', 'em-synchrony/em-http'] + gem 'coveralls', require: false + gem 'em-http-request', '>= 1.1', require: 'em-http' + gem 'em-synchrony', '>= 1.0.3', require: ['em-synchrony', 'em-synchrony/em-http'] gem 'excon', '>= 0.27.4' gem 'httpclient', '>= 2.2' gem 'minitest', '>= 5.0.5' gem 'net-http-persistent' - gem 'patron', '>= 0.4.2', :platforms => :ruby - gem 'rack-test', '>= 0.6', :require => 'rack/test' + gem 'patron', '>= 0.4.2', platforms: :ruby + gem 'rack-test', '>= 0.6', require: 'rack/test' gem 'rspec', '~> 3.7' gem 'rubocop', '~> 0.65.0' gem 'simplecov' gem 'sinatra', '~> 1.3' - gem 'typhoeus', '~> 1.3', :git => 'https://github.com/typhoeus/typhoeus.git', :require => 'typhoeus' + gem 'typhoeus', '~> 1.3', git: 'https://github.com/typhoeus/typhoeus.git', require: 'typhoeus' gem 'webmock', '~> 3.4' end diff --git a/Rakefile b/Rakefile index b1e0ed783..1d84452d8 100644 --- a/Rakefile +++ b/Rakefile @@ -5,7 +5,7 @@ require 'rake/testtask' require 'rspec/core/rake_task' RSpec::Core::RakeTask.new(:spec) -task :default => :test +task default: :test desc 'Run all tests' -task :test => [:spec] +task test: [:spec] diff --git a/lib/faraday/adapter.rb b/lib/faraday/adapter.rb index 713adf2ec..3f5f49ca7 100644 --- a/lib/faraday/adapter.rb +++ b/lib/faraday/adapter.rb @@ -10,16 +10,16 @@ class Adapter CONTENT_LENGTH = 'Content-Length' register_middleware File.expand_path('../adapter', __FILE__), - :test => [:Test, 'test'], - :net_http => [:NetHttp, 'net_http'], - :net_http_persistent => [:NetHttpPersistent, 'net_http_persistent'], - :typhoeus => [:Typhoeus, 'typhoeus'], - :patron => [:Patron, 'patron'], - :em_synchrony => [:EMSynchrony, 'em_synchrony'], - :em_http => [:EMHttp, 'em_http'], - :excon => [:Excon, 'excon'], - :rack => [:Rack, 'rack'], - :httpclient => [:HTTPClient, 'httpclient'] + test: [:Test, 'test'], + net_http: [:NetHttp, 'net_http'], + net_http_persistent: [:NetHttpPersistent, 'net_http_persistent'], + typhoeus: [:Typhoeus, 'typhoeus'], + patron: [:Patron, 'patron'], + em_synchrony: [:EMSynchrony, 'em_synchrony'], + em_http: [:EMHttp, 'em_http'], + excon: [:Excon, 'excon'], + rack: [:Rack, 'rack'], + httpclient: [:HTTPClient, 'httpclient'] # This module marks an Adapter as supporting parallel requests. module Parallelism diff --git a/lib/faraday/adapter/em_http.rb b/lib/faraday/adapter/em_http.rb index b52f878b0..af476ff0e 100644 --- a/lib/faraday/adapter/em_http.rb +++ b/lib/faraday/adapter/em_http.rb @@ -19,8 +19,8 @@ def connection_config(env) def request_config(env) options = { - :body => read_body(env), - :head => env[:request_headers] + body: read_body(env), + head: env[:request_headers] # :keepalive => true, # :file => 'path/to/file', # stream data off disk } @@ -37,9 +37,9 @@ def read_body(env) def configure_proxy(options, env) if (proxy = request_options(env)[:proxy]) options[:proxy] = { - :host => proxy[:uri].host, - :port => proxy[:uri].port, - :authorization => [proxy[:user], proxy[:password]] + host: proxy[:uri].host, + port: proxy[:uri].port, + authorization: [proxy[:user], proxy[:password]] } end end @@ -48,8 +48,8 @@ def configure_proxy(options, env) def configure_socket(options, env) if (bind = request_options(env)[:bind]) options[:bind] = { - :host => bind[:host], - :port => bind[:port] + host: bind[:host], + port: bind[:port] } end end @@ -58,8 +58,8 @@ def configure_socket(options, env) def configure_ssl(options, env) if env[:url].scheme == 'https' && env[:ssl] options[:ssl] = { - :cert_chain_file => env[:ssl][:ca_file], - :verify_peer => env[:ssl].fetch(:verify, true) + cert_chain_file: env[:ssl][:ca_file], + verify_peer: env[:ssl].fetch(:verify, true) } end end diff --git a/lib/faraday/adapter/em_synchrony/parallel_manager.rb b/lib/faraday/adapter/em_synchrony/parallel_manager.rb index f7e7d0e69..1c3759d2c 100644 --- a/lib/faraday/adapter/em_synchrony/parallel_manager.rb +++ b/lib/faraday/adapter/em_synchrony/parallel_manager.rb @@ -13,10 +13,10 @@ class ParallelManager # @param args [Array] the rest of the positional arguments def add(request, method, *args, &block) queue << { - :request => request, - :method => method, - :args => args, - :block => block + request: request, + method: method, + args: args, + block: block } end diff --git a/lib/faraday/adapter/excon.rb b/lib/faraday/adapter/excon.rb index 15369bf35..2f39f3ef0 100644 --- a/lib/faraday/adapter/excon.rb +++ b/lib/faraday/adapter/excon.rb @@ -40,12 +40,12 @@ def call(env) if req[:proxy] opts[:proxy] = { - :host => req[:proxy][:uri].host, - :hostname => req[:proxy][:uri].hostname, - :port => req[:proxy][:uri].port, - :scheme => req[:proxy][:uri].scheme, - :user => req[:proxy][:user], - :password => req[:proxy][:password] + host: req[:proxy][:uri].host, + hostname: req[:proxy][:uri].hostname, + port: req[:proxy][:uri].port, + scheme: req[:proxy][:uri].scheme, + user: req[:proxy][:user], + password: req[:proxy][:password] } end end @@ -53,9 +53,9 @@ def call(env) conn = create_connection(env, opts) resp = conn.request \ - :method => env[:method].to_s.upcase, - :headers => env[:request_headers], - :body => read_body(env) + method: env[:method].to_s.upcase, + headers: env[:request_headers], + body: read_body(env) if req.stream_response? warn "Streaming downloads for #{self.class.name} are not yet implemented." diff --git a/lib/faraday/adapter/httpclient.rb b/lib/faraday/adapter/httpclient.rb index f14c11920..9df8b752b 100644 --- a/lib/faraday/adapter/httpclient.rb +++ b/lib/faraday/adapter/httpclient.rb @@ -40,8 +40,8 @@ def call(env) env[:body] = env[:body].read if env[:body].respond_to? :read resp = client.request env[:method], env[:url], - :body => env[:body], - :header => env[:request_headers] + body: env[:body], + header: env[:request_headers] if (req = env[:request]).stream_response? warn "Streaming downloads for #{self.class.name} are not yet implemented." diff --git a/lib/faraday/adapter/patron.rb b/lib/faraday/adapter/patron.rb index c92200685..f4afe6020 100644 --- a/lib/faraday/adapter/patron.rb +++ b/lib/faraday/adapter/patron.rb @@ -29,7 +29,7 @@ def call(env) response = begin data = env[:body] ? env[:body].to_s : nil - session.request(env[:method], env[:url].to_s, env[:request_headers], :data => data) + session.request(env[:method], env[:url].to_s, env[:request_headers], data: data) rescue Errno::ECONNREFUSED, ::Patron::ConnectionFailed raise Faraday::ConnectionFailed, $! end diff --git a/lib/faraday/autoload.rb b/lib/faraday/autoload.rb index 9c20f4661..5f1ded2c7 100644 --- a/lib/faraday/autoload.rb +++ b/lib/faraday/autoload.rb @@ -55,34 +55,34 @@ def all_loaded_constants class Adapter extend AutoloadHelper autoload_all 'faraday/adapter', - :NetHttp => 'net_http', - :NetHttpPersistent => 'net_http_persistent', - :EMSynchrony => 'em_synchrony', - :EMHttp => 'em_http', - :Typhoeus => 'typhoeus', - :Patron => 'patron', - :Excon => 'excon', - :Test => 'test', - :Rack => 'rack', - :HTTPClient => 'httpclient' + NetHttp: 'net_http', + NetHttpPersistent: 'net_http_persistent', + EMSynchrony: 'em_synchrony', + EMHttp: 'em_http', + Typhoeus: 'typhoeus', + Patron: 'patron', + Excon: 'excon', + Test: 'test', + Rack: 'rack', + HTTPClient: 'httpclient' end class Request extend AutoloadHelper autoload_all 'faraday/request', - :UrlEncoded => 'url_encoded', - :Multipart => 'multipart', - :Retry => 'retry', - :Authorization => 'authorization', - :BasicAuthentication => 'basic_authentication', - :TokenAuthentication => 'token_authentication', - :Instrumentation => 'instrumentation' + UrlEncoded: 'url_encoded', + Multipart: 'multipart', + Retry: 'retry', + Authorization: 'authorization', + BasicAuthentication: 'basic_authentication', + TokenAuthentication: 'token_authentication', + Instrumentation: 'instrumentation' end class Response extend AutoloadHelper autoload_all 'faraday/response', - :RaiseError => 'raise_error', - :Logger => 'logger' + RaiseError: 'raise_error', + Logger: 'logger' end end diff --git a/lib/faraday/connection.rb b/lib/faraday/connection.rb index 413593c93..e327b755e 100644 --- a/lib/faraday/connection.rb +++ b/lib/faraday/connection.rb @@ -475,7 +475,7 @@ def run_request(method, url, body, headers) @temp_proxy = proxy_for_request(url) request = build_request(method) do |req| - req.options = req.options.merge(:proxy => @temp_proxy) + req.options = req.options.merge(proxy: @temp_proxy) req.url(url) if url req.headers.update(headers) if headers req.body = body if body @@ -527,11 +527,11 @@ def build_exclusive_url(url = nil, params = nil, params_encoder = nil) # @return [Faraday::Connection] def dup self.class.new(build_exclusive_url, - :headers => headers.dup, - :params => params.dup, - :builder => builder.dup, - :ssl => ssl.dup, - :request => options.dup) + headers: headers.dup, + params: params.dup, + builder: builder.dup, + ssl: ssl.dup, + request: options.dup) end # Yields username and password extracted from a URI if they both exist. diff --git a/lib/faraday/options/connection_options.rb b/lib/faraday/options/connection_options.rb index 6b3257b58..7d39a979f 100644 --- a/lib/faraday/options/connection_options.rb +++ b/lib/faraday/options/connection_options.rb @@ -4,7 +4,7 @@ module Faraday class ConnectionOptions < Options.new(:request, :proxy, :ssl, :builder, :url, :parallel_manager, :params, :headers, :builder_class) - options :request => RequestOptions, :ssl => SSLOptions + options request: RequestOptions, ssl: SSLOptions memoized(:request) { self.class.options_for(:request).new } diff --git a/lib/faraday/options/env.rb b/lib/faraday/options/env.rb index e8eace8ba..08c57d147 100644 --- a/lib/faraday/options/env.rb +++ b/lib/faraday/options/env.rb @@ -57,8 +57,8 @@ class Env < Options.new(:method, :request_body, :url, :request, :request_headers # these requests, the Content-Length header is set to 0. MethodsWithBodies = Set.new(Faraday::METHODS_WITH_BODY.map(&:to_sym)) - options :request => RequestOptions, - :request_headers => Utils::Headers, :response_headers => Utils::Headers + options request: RequestOptions, + request_headers: Utils::Headers, response_headers: Utils::Headers extend Forwardable diff --git a/lib/faraday/options/proxy_options.rb b/lib/faraday/options/proxy_options.rb index 4070c790c..0c5b631a3 100644 --- a/lib/faraday/options/proxy_options.rb +++ b/lib/faraday/options/proxy_options.rb @@ -8,9 +8,9 @@ class ProxyOptions < Options.new(:uri, :user, :password) def self.from(value) case value when String - value = {:uri => Utils.URI(value)} + value = {uri: Utils.URI(value)} when URI - value = {:uri => value} + value = {uri: value} when Hash, Options if (uri = value.delete(:uri)) value[:uri] = Utils.URI(uri) diff --git a/lib/faraday/request.rb b/lib/faraday/request.rb index 3b0c98653..c7d4745ed 100644 --- a/lib/faraday/request.rb +++ b/lib/faraday/request.rb @@ -28,13 +28,13 @@ class Request < Struct.new(:method, :path, :params, :headers, :body, :options) extend MiddlewareRegistry register_middleware File.expand_path('../request', __FILE__), - :url_encoded => [:UrlEncoded, 'url_encoded'], - :multipart => [:Multipart, 'multipart'], - :retry => [:Retry, 'retry'], - :authorization => [:Authorization, 'authorization'], - :basic_auth => [:BasicAuthentication, 'basic_authentication'], - :token_auth => [:TokenAuthentication, 'token_authentication'], - :instrumentation => [:Instrumentation, 'instrumentation'] + url_encoded: [:UrlEncoded, 'url_encoded'], + multipart: [:Multipart, 'multipart'], + retry: [:Retry, 'retry'], + authorization: [:Authorization, 'authorization'], + basic_auth: [:BasicAuthentication, 'basic_authentication'], + token_auth: [:TokenAuthentication, 'token_authentication'], + instrumentation: [:Instrumentation, 'instrumentation'] # @param request_method [String] # @yield [request] for block customization, if block given @@ -106,12 +106,12 @@ def []=(key, value) # @return [Hash] the hash ready to be serialized in Marshal. def marshal_dump { - :method => method, - :body => body, - :headers => headers, - :path => path, - :params => params, - :options => options + method: method, + body: body, + headers: headers, + path: path, + params: params, + options: options } end diff --git a/lib/faraday/response.rb b/lib/faraday/response.rb index c2c5bedc1..3cb5701c0 100644 --- a/lib/faraday/response.rb +++ b/lib/faraday/response.rb @@ -23,8 +23,8 @@ def on_complete(env) extend MiddlewareRegistry register_middleware File.expand_path('../response', __FILE__), - :raise_error => [:RaiseError, 'raise_error'], - :logger => [:Logger, 'logger'] + raise_error: [:RaiseError, 'raise_error'], + logger: [:Logger, 'logger'] def initialize(env = nil) @env = Env.from(env) if env @@ -77,8 +77,8 @@ def success? def to_hash { - :status => env.status, :body => env.body, - :response_headers => env.response_headers + status: env.status, body: env.body, + response_headers: env.response_headers } end diff --git a/lib/faraday/response/logger.rb b/lib/faraday/response/logger.rb index f33e2df4d..8a42d7104 100644 --- a/lib/faraday/response/logger.rb +++ b/lib/faraday/response/logger.rb @@ -6,7 +6,7 @@ module Faraday class Response::Logger < Response::Middleware extend Forwardable - DEFAULT_OPTIONS = { :headers => true, :bodies => false } + DEFAULT_OPTIONS = { headers: true, bodies: false } def initialize(app, logger = nil, options = {}) super(app) diff --git a/lib/faraday/response/raise_error.rb b/lib/faraday/response/raise_error.rb index 43b81678c..6292ab406 100644 --- a/lib/faraday/response/raise_error.rb +++ b/lib/faraday/response/raise_error.rb @@ -28,7 +28,7 @@ def on_complete(env) end def response_values(env) - {:status => env.status, :headers => env.response_headers, :body => env.body} + {status: env.status, headers: env.response_headers, body: env.body} end end end diff --git a/script/proxy-server b/script/proxy-server index c49575c84..07fd12aab 100755 --- a/script/proxy-server +++ b/script/proxy-server @@ -23,9 +23,9 @@ log_io = $stdout log_io.sync = true webrick_opts = { - :Port => port, :Logger => WEBrick::Log::new(log_io), - :AccessLog => [[log_io, '[%{X-Faraday-Adapter}i] %m %U -> %s %b']], - :ProxyAuthProc => lambda { |req, res| + Port: port, Logger: WEBrick::Log::new(log_io), + AccessLog: [[log_io, '[%{X-Faraday-Adapter}i] %m %U -> %s %b']], + ProxyAuthProc: lambda { |req, res| if username type, credentials = req.header['proxy-authorization'].first.to_s.split(/\s+/, 2) unless 'Basic' == type && match_credentials.call(credentials) diff --git a/script/server b/script/server index f283d6568..8f5af01a8 100755 --- a/script/server +++ b/script/server @@ -18,18 +18,18 @@ log_io = $stdout log_io.sync = true webrick_opts = { - :Port => port, :Logger => WEBrick::Log::new(log_io), - :AccessLog => [[log_io, '[%{X-Faraday-Adapter}i] %m %U -> %s %b']] + Port: port, Logger: WEBrick::Log::new(log_io), + AccessLog: [[log_io, '[%{X-Faraday-Adapter}i] %m %U -> %s %b']] } if ENV['SSL_KEY'] require 'openssl' require 'webrick/https' webrick_opts.update \ - :SSLEnable => true, - :SSLPrivateKey => OpenSSL::PKey::RSA.new(File.read(ENV['SSL_KEY'])), - :SSLCertificate => OpenSSL::X509::Certificate.new(File.read(ENV['SSL_FILE'])), - :SSLVerifyClient => OpenSSL::SSL::VERIFY_NONE + SSLEnable: true, + SSLPrivateKey: OpenSSL::PKey::RSA.new(File.read(ENV['SSL_KEY'])), + SSLCertificate: OpenSSL::X509::Certificate.new(File.read(ENV['SSL_FILE'])), + SSLVerifyClient: OpenSSL::SSL::VERIFY_NONE end Rack::Handler::WEBrick.run(Faraday::LiveServer, webrick_opts) do |server| diff --git a/spec/faraday/connection_spec.rb b/spec/faraday/connection_spec.rb index 3799caecb..27f246ae7 100644 --- a/spec/faraday/connection_spec.rb +++ b/spec/faraday/connection_spec.rb @@ -29,7 +29,7 @@ end it 'works with option url' do - conn = Faraday.new :url => 'http://sushi.com/foo' + conn = Faraday.new url: 'http://sushi.com/foo' expect(conn.options.timeout).to eq(10) end @@ -44,7 +44,7 @@ conn.options.timeout = 1 expect(Faraday.default_connection_options.request.timeout).to eq(10) - other = Faraday.new :url => 'https://sushi.com/foo' + other = Faraday.new url: 'https://sushi.com/foo' other.options.timeout = 1 expect(Faraday.default_connection_options.request.timeout).to eq(10) @@ -221,13 +221,13 @@ it 'does not use connection params' do conn.url_prefix = 'http://sushi.com/nigiri' - conn.params = { :a => 1 } + conn.params = { a: 1 } expect(conn.build_exclusive_url.to_s).to eq('http://sushi.com/nigiri') end it 'allows to provide params argument' do conn.url_prefix = 'http://sushi.com/nigiri' - conn.params = { :a => 1 } + conn.params = { a: 1 } params = Faraday::Utils::ParamsHash.new params[:a] = 2 uri = conn.build_exclusive_url(nil, params) @@ -345,7 +345,7 @@ it 'accepts hash with string uri' do with_env 'http_proxy' => 'http://proxy.com:80' do - conn.proxy = { :uri => 'http://proxy.com', :user => 'rick' } + conn.proxy = { uri: 'http://proxy.com', user: 'rick' } expect(conn.proxy.host).to eq('proxy.com') expect(conn.proxy.user).to eq('rick') end @@ -353,7 +353,7 @@ it 'accepts hash' do with_env 'http_proxy' => 'http://proxy.com:80' do - conn.proxy = { :uri => URI.parse('http://proxy.com'), :user => 'rick' } + conn.proxy = { uri: URI.parse('http://proxy.com'), user: 'rick' } expect(conn.proxy.host).to eq('proxy.com') expect(conn.proxy.user).to eq('rick') end @@ -593,7 +593,7 @@ expect(req.params[:a]).to eq('a') expect(req.params['c']).to eq(3) expect(req.params['p']).to eq(2) - req.params = { :b => 'b' } + req.params = { b: 'b' } expect(req.params['b']).to eq('b') end expect(stubbed).to have_been_made.once diff --git a/spec/faraday/options/options_spec.rb b/spec/faraday/options/options_spec.rb index 22d561270..79d6b55f3 100644 --- a/spec/faraday/options/options_spec.rb +++ b/spec/faraday/options/options_spec.rb @@ -169,7 +169,7 @@ class ParentOptions < Faraday::Options.new(:a, :b, :c) expect(options.a).to eq(1) expect(options.b).to be_nil - updated = options.update :a => 2, :b => 3 + updated = options.update a: 2, b: 3 expect(options.a).to eq(2) expect(options.b).to eq(3) expect(updated).to eq(options) diff --git a/spec/faraday/params_encoders/nested_spec.rb b/spec/faraday/params_encoders/nested_spec.rb index 2d9e4ca60..46c30b01e 100644 --- a/spec/faraday/params_encoders/nested_spec.rb +++ b/spec/faraday/params_encoders/nested_spec.rb @@ -60,7 +60,7 @@ end it 'encodes rack compat' do - params = { :a => [{ :one => '1', :two => '2' }, '3', ''] } + params = { a: [{ one: '1', two: '2' }, '3', ''] } result = Faraday::Utils.unescape(Faraday::NestedParamsEncoder.encode(params)).split('&') expected = Rack::Utils.build_nested_query(params).split('&') expect(result).to match_array(expected) diff --git a/spec/faraday/request/url_encoded_spec.rb b/spec/faraday/request/url_encoded_spec.rb index 9361646f0..cb03524e5 100644 --- a/spec/faraday/request/url_encoded_spec.rb +++ b/spec/faraday/request/url_encoded_spec.rb @@ -21,13 +21,13 @@ end it 'ignores custom content type' do - response = conn.post('/echo', { :some => 'data' }, 'content-type' => 'application/x-foo') + response = conn.post('/echo', { some: 'data' }, 'content-type' => 'application/x-foo') expect(response.headers['Content-Type']).to eq('application/x-foo') - expect(response.body).to eq({ :some => 'data' }) + expect(response.body).to eq({ some: 'data' }) end it 'works with no headers' do - response = conn.post('/echo', { :fruit => %w[apples oranges] }) + response = conn.post('/echo', { fruit: %w[apples oranges] }) expect(response.headers['Content-Type']).to eq('application/x-www-form-urlencoded') expect(response.body).to eq('fruit%5B%5D=apples&fruit%5B%5D=oranges') end @@ -39,14 +39,14 @@ end it 'works with nested params' do - response = conn.post('/echo', { :user => {:name => 'Mislav', :web => 'mislav.net'} }) + response = conn.post('/echo', { user: {name: 'Mislav', web: 'mislav.net'} }) expect(response.headers['Content-Type']).to eq('application/x-www-form-urlencoded') expected = { 'user' => {'name' => 'Mislav', 'web' => 'mislav.net'} } expect(Faraday::Utils.parse_nested_query(response.body)).to eq(expected) end it 'works with non nested params' do - response = conn.post('/echo', { :dimensions => ['date', 'location']}) do |req| + response = conn.post('/echo', { dimensions: ['date', 'location']}) do |req| req.options.params_encoder = Faraday::FlatParamsEncoder end expect(response.headers['Content-Type']).to eq('application/x-www-form-urlencoded') @@ -57,7 +57,7 @@ it 'works with unicode' do err = capture_warnings { - response = conn.post('/echo', {:str => 'eé cç aã aâ'}) + response = conn.post('/echo', {str: 'eé cç aã aâ'}) expect(response.body).to eq('str=e%C3%A9+c%C3%A7+a%C3%A3+a%C3%A2') } expect(err.empty?).to be_truthy diff --git a/spec/support/streaming_response_checker.rb b/spec/support/streaming_response_checker.rb index b22980bc8..38e5e8c60 100644 --- a/spec/support/streaming_response_checker.rb +++ b/spec/support/streaming_response_checker.rb @@ -4,8 +4,8 @@ module Faraday module StreamingResponseChecker def check_streaming_response(streamed, options = {}) opts = { - :prefix => '', - :streaming? => true + prefix: '', + streaming?: true }.merge(options) expected_response = opts[:prefix] + big_string diff --git a/test/adapters/em_http_test.rb b/test/adapters/em_http_test.rb index 89c314c64..98c8e3307 100644 --- a/test/adapters/em_http_test.rb +++ b/test/adapters/em_http_test.rb @@ -13,7 +13,7 @@ def adapter() :em_http end def test_binds_local_socket host = '1.2.3.4' - conn = create_connection :request => { :bind => { :host => host } } + conn = create_connection request: { bind: { host: host } } assert_equal host, conn.options[:bind][:host] end end unless jruby? and ssl_mode? diff --git a/test/adapters/em_synchrony_test.rb b/test/adapters/em_synchrony_test.rb index 1d29e7bfd..0126d7944 100644 --- a/test/adapters/em_synchrony_test.rb +++ b/test/adapters/em_synchrony_test.rb @@ -14,7 +14,7 @@ def adapter() :em_synchrony end def test_binds_local_socket host = '1.2.3.4' - conn = create_connection :request => { :bind => { :host => host } } + conn = create_connection request: { bind: { host: host } } # put conn.get('/who-am-i').body assert_equal host, conn.options[:bind][:host] end diff --git a/test/adapters/integration.rb b/test/adapters/integration.rb index ca13fd1c5..f52ef8aba 100644 --- a/test/adapters/integration.rb +++ b/test/adapters/integration.rb @@ -51,7 +51,7 @@ def test_callback_is_called_in_parallel_with_no_streaming_support err = capture_warnings do connection.in_parallel do resp1, streamed1 = streaming_request(connection, :get, 'stream?a=1') - resp2, streamed2 = streaming_request(connection, :get, 'stream?b=2', :chunk_size => 16 * 1024) + resp2, streamed2 = streaming_request(connection, :get, 'stream?b=2', chunk_size: 16 * 1024) assert connection.in_parallel? assert_nil resp1.body assert_nil resp2.body @@ -61,9 +61,9 @@ def test_callback_is_called_in_parallel_with_no_streaming_support end assert !connection.in_parallel? assert_match(/Streaming .+ not yet implemented/, err) - opts = { :streaming? => false, :chunk_size => 16 * 1024 } - check_streaming_response(streamed1, opts.merge(:prefix => '{"a"=>"1"}')) - check_streaming_response(streamed2, opts.merge(:prefix => '{"b"=>"2"}')) + opts = { streaming?: false, chunk_size: 16 * 1024 } + check_streaming_response(streamed1, opts.merge(prefix: '{"a"=>"1"}')) + check_streaming_response(streamed2, opts.merge(prefix: '{"b"=>"2"}')) end end @@ -76,7 +76,7 @@ def test_GET_streaming response, streamed = streaming_request(create_connection, :get, 'stream') end assert_match(/Streaming .+ not yet implemented/, err) - check_streaming_response(streamed, :streaming? => false) + check_streaming_response(streamed, streaming?: false) assert_equal big_string, response.body end @@ -88,7 +88,7 @@ def test_non_GET_streaming assert_match(/Streaming .+ not yet implemented/, err) - check_streaming_response(streamed, :streaming? => false) + check_streaming_response(streamed, streaming?: false) assert_equal big_string, response.body end end @@ -96,7 +96,7 @@ def test_non_GET_streaming module SSL def test_GET_ssl_fails_with_bad_cert ca_file = 'tmp/faraday-different-ca-cert.crt' - conn = create_connection(:ssl => { :ca_file => ca_file }) + conn = create_connection(ssl: { ca_file: ca_file }) err = assert_raises Faraday::SSLError do conn.get('/ssl') end diff --git a/test/adapters/rack_test.rb b/test/adapters/rack_test.rb index 7316fa7ce..f5a422243 100644 --- a/test/adapters/rack_test.rb +++ b/test/adapters/rack_test.rb @@ -26,7 +26,7 @@ def test_GET_reason_phrase # not using shared test because error is swallowed by Sinatra def test_timeout - conn = create_connection(:request => {:timeout => 1, :open_timeout => 1}) + conn = create_connection(request: {timeout: 1, open_timeout: 1}) begin conn.get '/slow' rescue Faraday::ClientError From f356cdd217846033a0b469bf91d0f3d80e8fbc22 Mon Sep 17 00:00:00 2001 From: iMacTia Date: Tue, 26 Feb 2019 10:22:39 +0000 Subject: [PATCH 2/2] Fixes rubocop Style/HashSyntax issues in comments as well. --- lib/faraday.rb | 6 +++--- lib/faraday/adapter/em_http.rb | 4 ++-- lib/faraday/adapter/rack.rb | 4 ++-- lib/faraday/adapter/test.rb | 14 +++++++------- lib/faraday/autoload.rb | 2 +- lib/faraday/connection.rb | 18 +++++++++--------- lib/faraday/middleware_registry.rb | 8 ++++---- lib/faraday/rack_builder.rb | 2 +- lib/faraday/utils/headers.rb | 2 +- 9 files changed, 30 insertions(+), 30 deletions(-) diff --git a/lib/faraday.rb b/lib/faraday.rb index 720eccd7a..5fc49b41b 100644 --- a/lib/faraday.rb +++ b/lib/faraday.rb @@ -72,12 +72,12 @@ class << self # # => Faraday::Connection to http://faraday.com # # @example With an URL argument and an options hash - # Faraday.new 'http://faraday.com', :params => {:page => 1} + # Faraday.new 'http://faraday.com', params: { page: 1 } # # => Faraday::Connection to http://faraday.com?page=1 # # @example With everything in an options hash - # Faraday.new :url => 'http://faraday.com', - # :params => {:page => 1} + # Faraday.new url: 'http://faraday.com', + # params: { page: 1 } # # => Faraday::Connection to http://faraday.com?page=1 def new(url = nil, options = nil, &block) options = options ? default_connection_options.merge(options) : default_connection_options diff --git a/lib/faraday/adapter/em_http.rb b/lib/faraday/adapter/em_http.rb index af476ff0e..988ce2b6c 100644 --- a/lib/faraday/adapter/em_http.rb +++ b/lib/faraday/adapter/em_http.rb @@ -21,8 +21,8 @@ def request_config(env) options = { body: read_body(env), head: env[:request_headers] - # :keepalive => true, - # :file => 'path/to/file', # stream data off disk + # keepalive: true, + # file: 'path/to/file', # stream data off disk } configure_compression(options, env) options diff --git a/lib/faraday/adapter/rack.rb b/lib/faraday/adapter/rack.rb index 2730c2f6e..11f273239 100644 --- a/lib/faraday/adapter/rack.rb +++ b/lib/faraday/adapter/rack.rb @@ -30,8 +30,8 @@ def initialize(faraday_app, rack_app) def call(env) super rack_env = { - :method => env[:method], - :input => env[:body].respond_to?(:read) ? env[:body].read : env[:body], + method: env[:method], + input: env[:body].respond_to?(:read) ? env[:body].read : env[:body], 'rack.url_scheme' => env[:url].scheme } diff --git a/lib/faraday/adapter/test.rb b/lib/faraday/adapter/test.rb index a083e4ddb..5504dfe57 100644 --- a/lib/faraday/adapter/test.rb +++ b/lib/faraday/adapter/test.rb @@ -11,12 +11,12 @@ class Adapter # # return static content # [200, {'Content-Type' => 'application/json'}, 'hi world'] # end - # + # # # response with content generated based on request # stub.get '/showget' do |env| # [200, {'Content-Type' => 'text/plain'}, env[:method].to_s] # end - # + # # # regular expression can be used as matching filter # stub.get /\A\/items\/(\d+)\z/ do |env, meta| # # in case regular expression is used an instance of MatchData can be received @@ -24,16 +24,16 @@ class Adapter # end # end # end - # + # # resp = test.get '/resource.json' # resp.body # => 'hi world' - # + # # resp = test.get '/showget' # resp.body # => 'get' - # + # # resp = test.get '/items/1' # resp.body # => 'showing item: 1' - # + # # resp = test.get '/items/2' # resp.body # => 'showing item: 2' # @@ -46,7 +46,7 @@ class NotFound < StandardError end def initialize - # {:get => [Stub, Stub]} + # { get: [Stub, Stub] } @stack, @consumed = {}, {} yield(self) if block_given? end diff --git a/lib/faraday/autoload.rb b/lib/faraday/autoload.rb index 5f1ded2c7..932977fe2 100644 --- a/lib/faraday/autoload.rb +++ b/lib/faraday/autoload.rb @@ -16,7 +16,7 @@ module AutoloadHelper # @example # # Faraday.autoload_all 'faraday/foo', - # :Bar => 'bar' + # Bar: 'bar' # # # requires faraday/foo/bar to load Faraday::Bar. # Faraday::Bar diff --git a/lib/faraday/connection.rb b/lib/faraday/connection.rb index e327b755e..b6c742ca6 100644 --- a/lib/faraday/connection.rb +++ b/lib/faraday/connection.rb @@ -116,13 +116,13 @@ def headers=(hash) # @param headers [Hash] unencoded HTTP header key/value pairs. # # @example - # conn.get '/items', {:page => 1}, :accept => 'application/json' + # conn.get '/items', { page: 1 }, :accept => 'application/json' # # # ElasticSearch example sending a body with GET. # conn.get '/twitter/tweet/_search' do |req| # req.headers[:content_type] = 'application/json' # req.params[:routing] = 'kimchy' - # req.body = JSON.generate(:query => {...}) + # req.body = JSON.generate(query: {...}) # end # # @yield [Faraday::Request] for further request customizations @@ -234,13 +234,13 @@ def options(*args) # @param headers [Hash] unencoded HTTP header key/value pairs. # # @example - # conn.post '/items', data, :content_type => 'application/json' + # conn.post '/items', data, content_type: 'application/json' # # # Simple ElasticSearch indexing sample. # conn.post '/twitter/tweet' do |req| # req.headers[:content_type] = 'application/json' # req.params[:routing] = 'kimchy' - # req.body = JSON.generate(:user => 'kimchy', ...) + # req.body = JSON.generate(user: 'kimchy', ...) # end # # @yield [Faraday::Request] for further request customizations @@ -257,13 +257,13 @@ def options(*args) # # @example # # TODO: Make it a PUT example - # conn.post '/items', data, :content_type => 'application/json' + # conn.post '/items', data, content_type: 'application/json' # # # Simple ElasticSearch indexing sample. # conn.post '/twitter/tweet' do |req| # req.headers[:content_type] = 'application/json' # req.params[:routing] = 'kimchy' - # req.body = JSON.generate(:user => 'kimchy', ...) + # req.body = JSON.generate(user: 'kimchy', ...) # end # # @yield [Faraday::Request] for further request customizations @@ -302,7 +302,7 @@ def basic_auth(login, pass) # # @example # - # conn.token_auth 'abcdef', :foo => 'bar' + # conn.token_auth 'abcdef', foo: 'bar' # conn.headers['Authorization'] # # => "Token token=\"abcdef\", # foo=\"bar\"" @@ -324,7 +324,7 @@ def token_auth(token, options = nil) # conn.headers['Authorization'] # # => "Bearer mF_9.B5f-4.1JqM" # - # conn.authorization :Token, :token => 'abcdef', :foo => 'bar' + # conn.authorization :Token, token: 'abcdef', foo: 'bar' # conn.headers['Authorization'] # # => "Token token=\"abcdef\", # foo=\"bar\"" @@ -446,7 +446,7 @@ def path_prefix=(value) # conn.path_prefix # => "/api" # # conn.build_url("nigiri?page=2") # => https://sushi.com/api/nigiri?token=abc&page=2 - # conn.build_url("nigiri", :page => 2) # => https://sushi.com/api/nigiri?token=abc&page=2 + # conn.build_url("nigiri", page: 2) # => https://sushi.com/api/nigiri?token=abc&page=2 # def build_url(url = nil, extra_params = nil) uri = build_exclusive_url(url) diff --git a/lib/faraday/middleware_registry.rb b/lib/faraday/middleware_registry.rb index 1ca01a942..6cf3fd234 100644 --- a/lib/faraday/middleware_registry.rb +++ b/lib/faraday/middleware_registry.rb @@ -20,7 +20,7 @@ module MiddlewareRegistry # module Faraday # class Whatever # # Middleware looked up by :foo returns Faraday::Whatever::Foo. - # register_middleware :foo => Foo + # register_middleware foo: Foo # end # end # @@ -29,7 +29,7 @@ module MiddlewareRegistry # module Faraday # class Whatever # # Middleware looked up by :bar returns Faraday::Whatever.const_get(:Bar) - # register_middleware :bar => :Bar + # register_middleware bar: :Bar # end # end # @@ -38,7 +38,7 @@ module MiddlewareRegistry # module Faraday # class Whatever # # Middleware looked up by :baz requires 'baz' and returns Faraday::Whatever.const_get(:Baz) - # register_middleware :baz => [:Baz, 'baz'] + # register_middleware baz: [:Baz, 'baz'] # end # end # @@ -70,7 +70,7 @@ def unregister_middleware(key) # # module Faraday # class Whatever - # register_middleware :foo => Foo + # register_middleware foo: Foo # end # end # diff --git a/lib/faraday/rack_builder.rb b/lib/faraday/rack_builder.rb index 2d50445ca..13d4c6475 100644 --- a/lib/faraday/rack_builder.rb +++ b/lib/faraday/rack_builder.rb @@ -4,7 +4,7 @@ module Faraday # A Builder that processes requests into responses by passing through an inner # middleware stack (heavily inspired by Rack). # - # Faraday::Connection.new(:url => 'http://sushi.com') do |builder| + # Faraday::Connection.new(url: 'http://sushi.com') do |builder| # builder.request :url_encoded # Faraday::Request::UrlEncoded # builder.adapter :net_http # Faraday::Adapter::NetHttp # end diff --git a/lib/faraday/utils/headers.rb b/lib/faraday/utils/headers.rb index 37b92633a..8e3342e48 100644 --- a/lib/faraday/utils/headers.rb +++ b/lib/faraday/utils/headers.rb @@ -41,7 +41,7 @@ def initialize_copy(other) value = if key.respond_to?(:to_str) key else - key.to_s.split('_') # :user_agent => %w(user agent) + key.to_s.split('_') # user_agent: %w(user agent) .each { |w| w.capitalize! } # => %w(User Agent) .join('-') # => "User-Agent" end