Merge pull request #649 from stripe/brandur-frozen-strings

Add `frozen_string_literal` to every file and enforce Rubocop rule
stripe · May 10, 2018 · ec66c3f · ec66c3f
2 parents 40e4883 + 863da48
commit ec66c3f
Show file tree

Hide file tree

Showing 124 changed files with 248 additions and 0 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -13,6 +13,9 @@ Layout/IndentArray:
 Layout/IndentHash:
   EnforcedStyle: consistent
 
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 

diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

diff --git a/Rakefile b/Rakefile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rake/testtask"
 require "rubocop/rake_task"
 

diff --git a/bin/stripe-console b/bin/stripe-console
@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require "irb"
 require "irb/completion"
 

diff --git a/lib/stripe.rb b/lib/stripe.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Stripe Ruby bindings
 # API spec at https://stripe.com/docs/api
 require "cgi"

diff --git a/lib/stripe/account.rb b/lib/stripe/account.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Account < APIResource
     extend Gem::Deprecate

diff --git a/lib/stripe/alipay_account.rb b/lib/stripe/alipay_account.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class AlipayAccount < APIResource
     include Stripe::APIOperations::Save

diff --git a/lib/stripe/api_operations/create.rb b/lib/stripe/api_operations/create.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   module APIOperations
     module Create

diff --git a/lib/stripe/api_operations/delete.rb b/lib/stripe/api_operations/delete.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   module APIOperations
     module Delete

diff --git a/lib/stripe/api_operations/list.rb b/lib/stripe/api_operations/list.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   module APIOperations
     module List

diff --git a/lib/stripe/api_operations/nested_resource.rb b/lib/stripe/api_operations/nested_resource.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   module APIOperations
     # Adds methods to help manipulate a subresource from its parent resource so

diff --git a/lib/stripe/api_operations/request.rb b/lib/stripe/api_operations/request.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   module APIOperations
     module Request

diff --git a/lib/stripe/api_operations/save.rb b/lib/stripe/api_operations/save.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   module APIOperations
     module Save

diff --git a/lib/stripe/api_resource.rb b/lib/stripe/api_resource.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class APIResource < StripeObject
     include Stripe::APIOperations::Request

diff --git a/lib/stripe/apple_pay_domain.rb b/lib/stripe/apple_pay_domain.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   # Domains registered for Apple Pay on the Web
   class ApplePayDomain < APIResource

diff --git a/lib/stripe/application_fee.rb b/lib/stripe/application_fee.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class ApplicationFee < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/application_fee_refund.rb b/lib/stripe/application_fee_refund.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class ApplicationFeeRefund < APIResource
     include Stripe::APIOperations::Save

diff --git a/lib/stripe/balance.rb b/lib/stripe/balance.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Balance < SingletonAPIResource
     OBJECT_NAME = "balance".freeze

diff --git a/lib/stripe/balance_transaction.rb b/lib/stripe/balance_transaction.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/bank_account.rb b/lib/stripe/bank_account.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class BankAccount < APIResource
     include Stripe::APIOperations::Save

diff --git a/lib/stripe/bitcoin_receiver.rb b/lib/stripe/bitcoin_receiver.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class BitcoinReceiver < APIResource
     # Directly creating or retrieving BitcoinReceivers is deprecated. Please use

diff --git a/lib/stripe/bitcoin_transaction.rb b/lib/stripe/bitcoin_transaction.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class BitcoinTransaction < APIResource
     # Directly retrieving BitcoinTransactions is deprecated. Please use the

diff --git a/lib/stripe/card.rb b/lib/stripe/card.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Card < APIResource
     include Stripe::APIOperations::Save

diff --git a/lib/stripe/charge.rb b/lib/stripe/charge.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Charge < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/country_spec.rb b/lib/stripe/country_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class CountrySpec < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/coupon.rb b/lib/stripe/coupon.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Coupon < APIResource
     extend Stripe::APIOperations::Create

diff --git a/lib/stripe/customer.rb b/lib/stripe/customer.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Customer < APIResource
     extend Stripe::APIOperations::Create

diff --git a/lib/stripe/dispute.rb b/lib/stripe/dispute.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Dispute < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/ephemeral_key.rb b/lib/stripe/ephemeral_key.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class EphemeralKey < APIResource
     extend Stripe::APIOperations::Create

diff --git a/lib/stripe/errors.rb b/lib/stripe/errors.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   # StripeError is the base error from which all other more specific Stripe
   # errors derive.

diff --git a/lib/stripe/event.rb b/lib/stripe/event.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Event < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/exchange_rate.rb b/lib/stripe/exchange_rate.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class ExchangeRate < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/file_upload.rb b/lib/stripe/file_upload.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class FileUpload < APIResource
     extend Stripe::APIOperations::Create

diff --git a/lib/stripe/invoice.rb b/lib/stripe/invoice.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Invoice < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/invoice_item.rb b/lib/stripe/invoice_item.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class InvoiceItem < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/invoice_line_item.rb b/lib/stripe/invoice_line_item.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class InvoiceLineItem < StripeObject
     OBJECT_NAME = "line_item".freeze

diff --git a/lib/stripe/issuer_fraud_record.rb b/lib/stripe/issuer_fraud_record.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class IssuerFraudRecord < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/list_object.rb b/lib/stripe/list_object.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class ListObject < StripeObject
     include Enumerable

diff --git a/lib/stripe/login_link.rb b/lib/stripe/login_link.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class LoginLink < APIResource
     OBJECT_NAME = "login_link".freeze

diff --git a/lib/stripe/oauth.rb b/lib/stripe/oauth.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   module OAuth
     module OAuthOperations

diff --git a/lib/stripe/order.rb b/lib/stripe/order.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Order < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/order_return.rb b/lib/stripe/order_return.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class OrderReturn < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/payout.rb b/lib/stripe/payout.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Payout < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/plan.rb b/lib/stripe/plan.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Plan < APIResource
     extend Stripe::APIOperations::Create

diff --git a/lib/stripe/product.rb b/lib/stripe/product.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Product < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/recipient.rb b/lib/stripe/recipient.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   # Recipients objects are deprecated. Please use Stripe Connect instead.
   class Recipient < APIResource

diff --git a/lib/stripe/recipient_transfer.rb b/lib/stripe/recipient_transfer.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class RecipientTransfer < StripeObject
     OBJECT_NAME = "recipient_transfer".freeze

diff --git a/lib/stripe/refund.rb b/lib/stripe/refund.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Refund < APIResource
     extend Stripe::APIOperations::Create

diff --git a/lib/stripe/reversal.rb b/lib/stripe/reversal.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Reversal < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/singleton_api_resource.rb b/lib/stripe/singleton_api_resource.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class SingletonAPIResource < APIResource
     def self.resource_url

diff --git a/lib/stripe/sku.rb b/lib/stripe/sku.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class SKU < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/source.rb b/lib/stripe/source.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Source < APIResource
     extend Stripe::APIOperations::Create

diff --git a/lib/stripe/source_transaction.rb b/lib/stripe/source_transaction.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class SourceTransaction < StripeObject
     OBJECT_NAME = "source_transaction".freeze

diff --git a/lib/stripe/stripe_client.rb b/lib/stripe/stripe_client.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   # StripeClient executes requests against the Stripe API and allows a user to
   # recover both a resource a call returns as well as a response object that

diff --git a/lib/stripe/stripe_object.rb b/lib/stripe/stripe_object.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class StripeObject
     include Enumerable

diff --git a/lib/stripe/stripe_response.rb b/lib/stripe/stripe_response.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   # StripeResponse encapsulates some vitals of a response that came back from
   # the Stripe API.

diff --git a/lib/stripe/subscription.rb b/lib/stripe/subscription.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Subscription < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/subscription_item.rb b/lib/stripe/subscription_item.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class SubscriptionItem < APIResource
     extend Stripe::APIOperations::Create

diff --git a/lib/stripe/three_d_secure.rb b/lib/stripe/three_d_secure.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class ThreeDSecure < APIResource
     extend Stripe::APIOperations::Create

diff --git a/lib/stripe/token.rb b/lib/stripe/token.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Token < APIResource
     extend Stripe::APIOperations::Create

diff --git a/lib/stripe/topup.rb b/lib/stripe/topup.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Topup < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/transfer.rb b/lib/stripe/transfer.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class Transfer < APIResource
     extend Stripe::APIOperations::List

diff --git a/lib/stripe/usage_record.rb b/lib/stripe/usage_record.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   class UsageRecord < APIResource
     def self.create(params = {}, opts = {})

diff --git a/lib/stripe/util.rb b/lib/stripe/util.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cgi"
 
 module Stripe

diff --git a/lib/stripe/version.rb b/lib/stripe/version.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   VERSION = "3.14.0".freeze
 end