add frozen_string_literal magic comment (#1408)

yawboakye · web-flow · commit a2e8ad556337 · 2023-09-18T10:31:44.000-04:00
for efficient string storage since we don't mutate any of the string
literals after they have been declared. in essence, they're already
being used as frozen values.
diff --git a/lib/jsonapi-resources.rb b/lib/jsonapi-resources.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jsonapi/resources/railtie'
 require 'jsonapi/naive_cache'
 require 'jsonapi/compiled_json'
diff --git a/lib/jsonapi/active_relation_resource.rb b/lib/jsonapi/active_relation_resource.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class ActiveRelationResource < BasicResource
     root_resource
diff --git a/lib/jsonapi/acts_as_resource_controller.rb b/lib/jsonapi/acts_as_resource_controller.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'csv'
 
 module JSONAPI
diff --git a/lib/jsonapi/basic_resource.rb b/lib/jsonapi/basic_resource.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jsonapi/callbacks'
 require 'jsonapi/configuration'
 
diff --git a/lib/jsonapi/cached_response_fragment.rb b/lib/jsonapi/cached_response_fragment.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class CachedResponseFragment
 
diff --git a/lib/jsonapi/callbacks.rb b/lib/jsonapi/callbacks.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/callbacks'
 
 module JSONAPI
diff --git a/lib/jsonapi/compiled_json.rb b/lib/jsonapi/compiled_json.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class CompiledJson
     def self.compile(h)
diff --git a/lib/jsonapi/configuration.rb b/lib/jsonapi/configuration.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jsonapi/formatter'
 require 'jsonapi/processor'
 require 'concurrent'
diff --git a/lib/jsonapi/error.rb b/lib/jsonapi/error.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Error
     attr_accessor :title, :detail, :id, :href, :code, :source, :links, :status, :meta
diff --git a/lib/jsonapi/error_codes.rb b/lib/jsonapi/error_codes.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   VALIDATION_ERROR = '100'
   INVALID_RESOURCE = '101'
diff --git a/lib/jsonapi/exceptions.rb b/lib/jsonapi/exceptions.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Exceptions
     class Error < RuntimeError
diff --git a/lib/jsonapi/formatter.rb b/lib/jsonapi/formatter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Formatter
     class << self
diff --git a/lib/jsonapi/include_directives.rb b/lib/jsonapi/include_directives.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class IncludeDirectives
     # Construct an IncludeDirectives Hash from an array of dot separated include strings.
diff --git a/lib/jsonapi/link_builder.rb b/lib/jsonapi/link_builder.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class LinkBuilder
     attr_reader :base_url,
diff --git a/lib/jsonapi/mime_types.rb b/lib/jsonapi/mime_types.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module JSONAPI
diff --git a/lib/jsonapi/naive_cache.rb b/lib/jsonapi/naive_cache.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
 
   # Cache which memoizes the given block.
diff --git a/lib/jsonapi/operation.rb b/lib/jsonapi/operation.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Operation
     attr_reader :resource_klass, :operation_type, :options
diff --git a/lib/jsonapi/operation_result.rb b/lib/jsonapi/operation_result.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class OperationResult
     attr_accessor :code
diff --git a/lib/jsonapi/paginator.rb b/lib/jsonapi/paginator.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Paginator
     def initialize(_params)
diff --git a/lib/jsonapi/path.rb b/lib/jsonapi/path.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Path
     attr_reader :segments, :resource_klass
diff --git a/lib/jsonapi/path_segment.rb b/lib/jsonapi/path_segment.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class PathSegment
     def self.parse(source_resource_klass:, segment_string:, parse_fields: true)
diff --git a/lib/jsonapi/processor.rb b/lib/jsonapi/processor.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Processor
     include Callbacks
diff --git a/lib/jsonapi/relationship.rb b/lib/jsonapi/relationship.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Relationship
     attr_reader :acts_as_set, :foreign_key, :options, :name,
diff --git a/lib/jsonapi/request.rb b/lib/jsonapi/request.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Request
     attr_accessor :fields, :include, :filters, :sort_criteria, :errors, :controller_module_path,
diff --git a/lib/jsonapi/resource.rb b/lib/jsonapi/resource.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class Resource < ActiveRelationResource
     root_resource
diff --git a/lib/jsonapi/resource_controller.rb b/lib/jsonapi/resource_controller.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class ResourceController < ActionController::Base
     include JSONAPI::ActsAsResourceController
diff --git a/lib/jsonapi/resource_controller_metal.rb b/lib/jsonapi/resource_controller_metal.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class ResourceControllerMetal < ActionController::Metal
     MODULES = [
diff --git a/lib/jsonapi/resource_fragment.rb b/lib/jsonapi/resource_fragment.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
 
   # A ResourceFragment holds a ResourceIdentity and associated partial resource data.
diff --git a/lib/jsonapi/resource_identity.rb b/lib/jsonapi/resource_identity.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
 
   # ResourceIdentity describes a unique identity of a resource in the system.
diff --git a/lib/jsonapi/resource_serializer.rb b/lib/jsonapi/resource_serializer.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class ResourceSerializer
 
diff --git a/lib/jsonapi/resource_set.rb b/lib/jsonapi/resource_set.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   # Contains a hash of resource types which contain a hash of resources, relationships and primary status keyed by
   # resource id.
diff --git a/lib/jsonapi/resource_tree.rb b/lib/jsonapi/resource_tree.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
 
   # A tree structure representing the resource structure of the requested resource(s). This is an intermediate structure
diff --git a/lib/jsonapi/response_document.rb b/lib/jsonapi/response_document.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   class ResponseDocument
     attr_reader :serialized_results
diff --git a/lib/jsonapi/routing_ext.rb b/lib/jsonapi/routing_ext.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionDispatch
   module Routing
     class Mapper

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'jsonapi/resources/railtie'`
`2`	`4`	`require 'jsonapi/naive_cache'`
`3`	`5`	`require 'jsonapi/compiled_json'`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`module JSONAPI`
`2`	`4`	`class ActiveRelationResource < BasicResource`
`3`	`5`	`root_resource`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'csv'`
`2`	`4`
`3`	`5`	`module JSONAPI`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'jsonapi/callbacks'`
`2`	`4`	`require 'jsonapi/configuration'`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'active_support/callbacks'`
`2`	`4`
`3`	`5`	`module JSONAPI`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'jsonapi/formatter'`
`2`	`4`	`require 'jsonapi/processor'`
`3`	`5`	`require 'concurrent'`