Merge pull request #794 from Shopify/fix_more_rubocop_issues

Enabling frozen string literal cop

.rubocop_todo.yml

@@ -27,13 +27,6 @@ Style/CommandLiteral:
   Exclude:
     - 'shopify_api.gemspec'
 
-# Offense count: 150
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # Offense count: 1
 Style/MissingRespondToMissing:
   Exclude:

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+
+* Freeze all string literals. This should have no impact unless your application is modifying ('monkeypatching') the internals of the library in an unusual way.
+
 ## Version 9.2.0
 
 * Removes the `shopify` binary which will be used by the Shopify CLI

Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source "https://rubygems.org"
 
 gemspec

Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rake'
 require "bundler/gem_tasks"
 require 'rake/testtask'

lib/active_resource/connection_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/connection'
 
 module ActiveResource

lib/active_resource/detailed_log_subscriber.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveResource
   class DetailedLogSubscriber < ActiveSupport::LogSubscriber
     VERSION_EOL_WARNING_HEADER = 'x-shopify-api-version-warning'

lib/active_resource/json_errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_resource/base'
 
 module ActiveResource

lib/shopify_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $:.unshift(File.dirname(__FILE__))
 require 'active_resource'
 require 'active_support/core_ext/class/attribute_accessors'

lib/shopify_api/connection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Connection < ActiveResource::Connection
     attr_reader :response

lib/shopify_api/countable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   module Countable
     def count(options = {})

lib/shopify_api/events.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   module Events
     def events

lib/shopify_api/limits.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   module Limits
     class LimitUnavailable < StandardError; end

lib/shopify_api/message_enricher.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class MessageEnricher < SimpleDelegator
     def message

lib/shopify_api/metafields.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   module Metafields
     def metafields(**options)

lib/shopify_api/pagination_link_headers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class InvalidPaginationLinksError < StandardError; end
 

lib/shopify_api/resources.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/resources/base'
 require 'shopify_api/resources/array_base'
 Dir.glob("#{File.dirname(__FILE__)}/resources/*").each { |file| require(file) }

lib/shopify_api/resources/access_token.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class AccessToken < Base
     def self.delegate(access_scope, expires_in = nil)

lib/shopify_api/resources/address.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Address < Base
   end

lib/shopify_api/resources/announcement.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Announcement < Base
   end

lib/shopify_api/resources/application_charge.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ApplicationCharge < Base
     undef_method :test

lib/shopify_api/resources/application_credit.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ApplicationCredit < Base
   end

lib/shopify_api/resources/article.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Article < Base
     include Events

lib/shopify_api/resources/asset.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   # Assets represent the files that comprise your theme.
   # There are different buckets which hold different kinds

lib/shopify_api/resources/assigned_fulfillment_order.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class AssignedFulfillmentOrder < Base
     def initialize(attributes = {}, persisted = false)

lib/shopify_api/resources/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/version'
 
 module ShopifyAPI

lib/shopify_api/resources/billing_address.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class BillingAddress < Base
   end

lib/shopify_api/resources/blog.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Blog < Base
     include Events

lib/shopify_api/resources/carrier_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class CarrierService < Base
   end

lib/shopify_api/resources/cart.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Cart < Base
   end

lib/shopify_api/resources/collect.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   # For adding/removing products from custom collections
   class Collect < Base

lib/shopify_api/resources/collection_listing.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class CollectionListing < Base
     self.primary_key = :collection_id

lib/shopify_api/resources/comment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Comment < Base
     def remove

lib/shopify_api/resources/country.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Country < Base
   end

lib/shopify_api/resources/custom_collection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class CustomCollection < Base
     include Events

lib/shopify_api/resources/customer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Customer < Base
     include Metafields

lib/shopify_api/resources/customer_group.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/resources/customer_saved_search'
 
 module ShopifyAPI

lib/shopify_api/resources/customer_invite.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class CustomerInvite < Base
   end

lib/shopify_api/resources/customer_saved_search.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/resources/customer'
 
 module ShopifyAPI

lib/shopify_api/resources/discount_code.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class DiscountCode < Base
     init_prefix :price_rule

lib/shopify_api/resources/draft_order.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class DraftOrder < Base
     include Metafields

lib/shopify_api/resources/draft_order_invoice.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class DraftOrderInvoice < Base
   end

lib/shopify_api/resources/event.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Event < Base
     include DisablePrefixCheck

lib/shopify_api/resources/fulfillment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Fulfillment < Base
     init_prefix :order

lib/shopify_api/resources/fulfillment_event.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentEvent < Base
     self.resource_prefix = "orders/:order_id/fulfillments/:fulfillment_id/"

lib/shopify_api/resources/fulfillment_order.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentOrder < Base
     MINIMUM_VERSION = '2020-01'

lib/shopify_api/resources/fulfillment_order_locations_for_move.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentOrderLocationsForMove < Base
   end

lib/shopify_api/resources/fulfillment_request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentRequest < Base
     init_prefix :order

lib/shopify_api/resources/fulfillment_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentService < Base
   end

lib/shopify_api/resources/fulfillment_v2.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentV2 < Base
     self.element_name = 'fulfillment'

lib/shopify_api/resources/gift_card.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class GiftCard < Base
     def disable

lib/shopify_api/resources/image.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Image < Base
     init_prefix :product

lib/shopify_api/resources/line_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class LineItem < Base
     class Property < Base

lib/shopify_api/resources/location.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Location < Base
     def inventory_levels

lib/shopify_api/resources/marketing_event.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class MarketingEvent < Base
     include Countable

lib/shopify_api/resources/metafield.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Metafield < Base
     include DisablePrefixCheck

lib/shopify_api/resources/note_attribute.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class NoteAttribute < Base
   end

lib/shopify_api/resources/option.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Option < Base
   end

lib/shopify_api/resources/order.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Order < Base
     include Events

lib/shopify_api/resources/order_risk.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class OrderRisk < Base
     init_prefix :order

lib/shopify_api/resources/page.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Page < Base
     include Events

lib/shopify_api/resources/payment_details.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class PaymentDetails < Base
   end

lib/shopify_api/resources/policy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Policy < Base
     def self.all

lib/shopify_api/resources/price_rule.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class PriceRule < Base
     def discount_codes

lib/shopify_api/resources/product.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Product < Base
     include Events

lib/shopify_api/resources/product_listing.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ProductListing < Base
     self.primary_key = :product_id

lib/shopify_api/resources/province.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Province < Base
     init_prefix :country

lib/shopify_api/resources/receipt.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Receipt < Base
   end

lib/shopify_api/resources/recurring_application_charge.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class RecurringApplicationCharge < Base
     undef_method :test

lib/shopify_api/resources/redirect.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Redirect < Base
   end

lib/shopify_api/resources/refund.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Refund < Base
     init_prefix :order

lib/shopify_api/resources/report.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Report < Base
   end

lib/shopify_api/resources/rule.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Rule < Base
   end

lib/shopify_api/resources/script_tag.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ScriptTag < Base
   end

lib/shopify_api/resources/shipping_address.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ShippingAddress < Base
   end

lib/shopify_api/resources/shipping_line.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ShippingLine < Base
   end

lib/shopify_api/resources/shipping_zone.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ShippingZone < Base
   end

lib/shopify_api/resources/shop.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   # Shop object. Use Shop.current to receive
   # the shop.

lib/shopify_api/resources/smart_collection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class SmartCollection < Base
     include Events

lib/shopify_api/resources/storefront_access_token.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class StorefrontAccessToken < Base
   end

lib/shopify_api/resources/tax_line.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class TaxLine < Base
   end

lib/shopify_api/resources/tax_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class TaxService < Base
   end

lib/shopify_api/resources/theme.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Theme < Base
   end

lib/shopify_api/resources/transaction.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Transaction < Base
     init_prefix :order

lib/shopify_api/resources/usage_charge.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class UsageCharge < Base
     init_prefix :recurring_application_charge

lib/shopify_api/resources/user.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class User < Base
   end

lib/shopify_api/resources/variant.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Variant < Base
     include Metafields

lib/shopify_api/resources/webhook.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Webhook < Base
   end

lib/shopify_api/session.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'openssl'
 require 'rack'
 

lib/shopify_api/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   VERSION = "9.2.0"
 end

lib/verify_docs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class VerifyDocs
   def self.call
     readme_content = File.read("README.md").lines[2..-1]

shopify_api.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $:.push(File.expand_path("../lib", __FILE__))
 require "shopify_api/version"
 

test/access_token_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class AccessTokenTest < Test::Unit::TestCase

test/active_resource/json_errors_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module ActiveResource

test/application_charge_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class ApplicationChargeTest < Test::Unit::TestCase

test/application_credit_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class ApplicationCreditTest < Test::Unit::TestCase

test/article_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class ArticleTest < Test::Unit::TestCase

test/asset_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class AssetTest < Test::Unit::TestCase

test/assigned_fulfillment_order_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 require 'fulfillment_order_test_helper'
 

test/base_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 require "active_support/log_subscriber/test_helper"
 

test/blog_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 class BlogTest < Test::Unit::TestCase
   test "blog creation" do