rename nil: true option to nilable: true

DataDog · Jul 19, 2023 · b3af7d3 · b3af7d3
1 parent 29a62b3
commit b3af7d3
Show file tree

Hide file tree

Showing 36 changed files with 48 additions and 48 deletions.
diff --git a/lib/datadog/core/configuration/option.rb b/lib/datadog/core/configuration/option.rb
@@ -138,15 +138,15 @@ def validate_type(value)
           valid_type = validate(@definition.type, value)
 
           unless valid_type
-            raise_error = if @definition.type_options[:nil]
+            raise_error = if @definition.type_options[:nilable]
                             !value.is_a?(NilClass)
                           else
                             true
                           end
           end
 
           if raise_error
-            error_msg = if @definition.type_options[:nil]
+            error_msg = if @definition.type_options[:nilable]
                           "The option #{@definition.name} support this type `#{@definition.type}` "\
                                       "and `nil` but the value provided is #{value.class}"
                         else

diff --git a/lib/datadog/core/configuration/settings.rb b/lib/datadog/core/configuration/settings.rb
@@ -79,7 +79,7 @@ def initialize(*_)
         # @default `DD_API_KEY` environment variable, otherwise `nil`
         # @return [String,nil]
         option :api_key do |o|
-          o.type :string, nil: true
+          o.type :string, nilable: true
           o.env Core::Environment::Ext::ENV_API_KEY
         end
 
@@ -457,7 +457,7 @@ def initialize(*_)
         # @default `DD_SITE` environment variable, otherwise `nil` which sends data to `app.datadoghq.com`
         # @return [String,nil]
         option :site do |o|
-          o.type :string, nil: true
+          o.type :string, nilable: true
           o.env Core::Environment::Ext::ENV_SITE
         end
 
@@ -468,7 +468,7 @@ def initialize(*_)
         # @default `DD_TAGS` environment variable (in the format `'tag1:value1,tag2:value2'`), otherwise `{}`
         # @return [Hash<String,String>]
         option :tags do |o|
-          o.type :hash, nil: true
+          o.type :hash, nilable: true
           o.env Core::Environment::Ext::ENV_TAGS
           o.env_parser do |env_value|
             values = if env_value.include?(',')
@@ -553,7 +553,7 @@ def initialize(*_)
         # @return [String,nil]
         option :version do |o|
           # NOTE: version also gets set as a side effect of tags. See the WORKAROUND note in #initialize for details.
-          o.type :string, nil: true
+          o.type :string, nilable: true
           o.env Core::Environment::Ext::ENV_VERSION
         end
 

diff --git a/lib/datadog/tracing/configuration/settings.rb b/lib/datadog/tracing/configuration/settings.rb
@@ -27,7 +27,7 @@ def self.extended(base)
                 # @default `DD_TRACE_ANALYTICS_ENABLED` environment variable, otherwise `nil`
                 # @return [Boolean,nil]
                 option :enabled do |o|
-                  o.type :bool, nil: true
+                  o.type :bool, nilable: true
                   o.env Tracing::Configuration::Ext::Analytics::ENV_TRACE_ANALYTICS_ENABLED
                 end
               end
@@ -295,7 +295,7 @@ def self.extended(base)
                 # @default `DD_TRACE_SAMPLE_RATE` environment variable, otherwise `nil`.
                 # @return [Float]
                 option :default_rate do |o|
-                  o.type :float, nil: true
+                  o.type :float, nilable: true
                   o.env Tracing::Configuration::Ext::Sampling::ENV_SAMPLE_RATE
                 end
 
@@ -307,7 +307,7 @@ def self.extended(base)
                 # @default `DD_TRACE_RATE_LIMIT` environment variable, otherwise 100.
                 # @return [Numeric,nil]
                 option :rate_limit do |o|
-                  o.type :int, nil: true
+                  o.type :int, nilable: true
                   o.env Tracing::Configuration::Ext::Sampling::ENV_RATE_LIMIT
                   o.default 100
                 end
@@ -340,7 +340,7 @@ def self.extended(base)
                 # @return [String,nil]
                 # @public_api
                 option :span_rules do |o|
-                  o.type :string, nil: true
+                  o.type :string, nilable: true
                   o.default do
                     rules = ENV[Tracing::Configuration::Ext::Sampling::Span::ENV_SPAN_SAMPLING_RULES]
                     rules_file = ENV[Tracing::Configuration::Ext::Sampling::Span::ENV_SPAN_SAMPLING_RULES_FILE]
@@ -402,7 +402,7 @@ def self.extended(base)
               # @default `nil`
               # @return [Proc,nil]
               option :transport_options do |o|
-                o.type :proc, nil: true
+                o.type :proc, nilable: true
                 o.default nil
               end
               # A custom writer instance.
@@ -462,7 +462,7 @@ def self.extended(base)
                 # @default `DD_TRACE_CLIENT_IP_HEADER` environment variable, otherwise `nil`.
                 # @return [String,nil]
                 option :header_name do |o|
-                  o.type :string, nil: true
+                  o.type :string, nilable: true
                   o.env Tracing::Configuration::Ext::ClientIp::ENV_HEADER_NAME
                 end
               end

diff --git a/lib/datadog/tracing/contrib/action_pack/configuration/settings.rb b/lib/datadog/tracing/contrib/action_pack/configuration/settings.rb
@@ -18,7 +18,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :analytics_enabled do |o|
-              o.type :bool, nil: true
+              o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED
             end
 

diff --git a/lib/datadog/tracing/contrib/active_job/configuration/settings.rb b/lib/datadog/tracing/contrib/active_job/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
 
             option :service_name
             option :error_handler do |o|
-              o.type :proc, nil: true
+              o.type :proc, nilable: true
               o.experimental_default_proc Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
             end
           end

diff --git a/lib/datadog/tracing/contrib/aws/configuration/settings.rb b/lib/datadog/tracing/contrib/aws/configuration/settings.rb
@@ -31,7 +31,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/dalli/configuration/settings.rb b/lib/datadog/tracing/contrib/dalli/configuration/settings.rb
@@ -30,7 +30,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/delayed_job/configuration/settings.rb b/lib/datadog/tracing/contrib/delayed_job/configuration/settings.rb
@@ -33,7 +33,7 @@ class Settings < Contrib::Configuration::Settings
             option :service_name
             option :client_service_name
             option :error_handler do |o|
-              o.type :proc, nil: true
+              o.type :proc, nilable: true
               o.experimental_default_proc Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
             end
           end

diff --git a/lib/datadog/tracing/contrib/elasticsearch/configuration/settings.rb b/lib/datadog/tracing/contrib/elasticsearch/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
             option :quantize, default: {}
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/ethon/configuration/settings.rb b/lib/datadog/tracing/contrib/ethon/configuration/settings.rb
@@ -34,7 +34,7 @@ class Settings < Contrib::Configuration::Settings
             option :split_by_domain, default: false, type: :bool
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/excon/configuration/settings.rb b/lib/datadog/tracing/contrib/excon/configuration/settings.rb
@@ -31,12 +31,12 @@ class Settings < Contrib::Configuration::Settings
 
             option :distributed_tracing, default: true, type: :bool
             option :error_handler do |o|
-              o.type :proc, nil: true
+              o.type :proc, nilable: true
             end
             option :split_by_domain, default: false, type: :bool
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/faraday/configuration/settings.rb b/lib/datadog/tracing/contrib/faraday/configuration/settings.rb
@@ -35,13 +35,13 @@ class Settings < Contrib::Configuration::Settings
 
             option :distributed_tracing, default: true, type: :bool
             option :error_handler do |o|
-              o.type :proc, nil: true
+              o.type :proc, nilable: true
               o.experimental_default_proc DEFAULT_ERROR_HANDLER
             end
             option :split_by_domain, default: false, type: :bool
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/grape/configuration/settings.rb b/lib/datadog/tracing/contrib/grape/configuration/settings.rb
@@ -19,7 +19,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :analytics_enabled do |o|
-              o.type :bool, nil: true
+              o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED
             end
 

diff --git a/lib/datadog/tracing/contrib/graphql/configuration/settings.rb b/lib/datadog/tracing/contrib/graphql/configuration/settings.rb
@@ -18,7 +18,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :analytics_enabled do |o|
-              o.type :bool, nil: true
+              o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED
             end
 

diff --git a/lib/datadog/tracing/contrib/grpc/configuration/settings.rb b/lib/datadog/tracing/contrib/grpc/configuration/settings.rb
@@ -33,7 +33,7 @@ class Settings < Contrib::Configuration::Settings
             option :distributed_tracing, default: true, type: :bool
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(
@@ -44,7 +44,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :error_handler do |o|
-              o.type :proc, nil: true
+              o.type :proc, nilable: true
               o.experimental_default_proc Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
             end
           end

diff --git a/lib/datadog/tracing/contrib/http/configuration/settings.rb b/lib/datadog/tracing/contrib/http/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
             option :distributed_tracing, default: true, type: :bool
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/httpclient/configuration/settings.rb b/lib/datadog/tracing/contrib/httpclient/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
             option :distributed_tracing, default: true, type: :bool
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/httprb/configuration/settings.rb b/lib/datadog/tracing/contrib/httprb/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
             option :distributed_tracing, default: true, type: :bool
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/mongodb/configuration/settings.rb b/lib/datadog/tracing/contrib/mongodb/configuration/settings.rb
@@ -34,7 +34,7 @@ class Settings < Contrib::Configuration::Settings
             option :quantize, default: DEFAULT_QUANTIZE
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/mysql2/configuration/settings.rb b/lib/datadog/tracing/contrib/mysql2/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/opensearch/configuration/settings.rb b/lib/datadog/tracing/contrib/opensearch/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
             option :quantize, default: {}
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/pg/configuration/settings.rb b/lib/datadog/tracing/contrib/pg/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/presto/configuration/settings.rb b/lib/datadog/tracing/contrib/presto/configuration/settings.rb
@@ -30,7 +30,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/que/configuration/settings.rb b/lib/datadog/tracing/contrib/que/configuration/settings.rb
@@ -45,7 +45,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :error_handler do |o|
-              o.type :proc, nil: true
+              o.type :proc, nilable: true
               o.experimental_default_proc Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
             end
           end

diff --git a/lib/datadog/tracing/contrib/racecar/configuration/settings.rb b/lib/datadog/tracing/contrib/racecar/configuration/settings.rb
@@ -30,7 +30,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(
                   value,

diff --git a/lib/datadog/tracing/contrib/rack/configuration/settings.rb b/lib/datadog/tracing/contrib/rack/configuration/settings.rb
@@ -23,7 +23,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :analytics_enabled do |o|
-              o.type :bool, nil: true
+              o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED
             end
 

diff --git a/lib/datadog/tracing/contrib/rails/configuration/settings.rb b/lib/datadog/tracing/contrib/rails/configuration/settings.rb
@@ -30,7 +30,7 @@ def initialize(options = {})
             end
 
             option :analytics_enabled do |o|
-              o.type :bool, nil: true
+              o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED
               o.on_set do |value|
                 # Update ActionPack analytics too

diff --git a/lib/datadog/tracing/contrib/redis/configuration/settings.rb b/lib/datadog/tracing/contrib/redis/configuration/settings.rb
@@ -36,7 +36,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/resque/configuration/settings.rb b/lib/datadog/tracing/contrib/resque/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
 
             option :service_name
             option :error_handler do |o|
-              o.type :proc, nil: true
+              o.type :proc, nilable: true
               o.experimental_default_proc Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
             end
           end

diff --git a/lib/datadog/tracing/contrib/rest_client/configuration/settings.rb b/lib/datadog/tracing/contrib/rest_client/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
             option :distributed_tracing, default: true, type: :bool
 
             option :service_name do |o|
-              o.type :string, nil: true
+              o.type :string, nilable: true
               o.env Ext::ENV_SERVICE_NAME
               o.setter do |value|
                 Contrib::SpanAttributeSchema.fetch_service_name(

diff --git a/lib/datadog/tracing/contrib/shoryuken/configuration/settings.rb b/lib/datadog/tracing/contrib/shoryuken/configuration/settings.rb
@@ -32,7 +32,7 @@ class Settings < Contrib::Configuration::Settings
 
             option :service_name
             option :error_handler do |o|
-              o.type :proc, nil: true
+              o.type :proc, nilable: true
               o.experimental_default_proc Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
             end
             option :tag_body, default: false, type: :bool

diff --git a/lib/datadog/tracing/contrib/sidekiq/configuration/settings.rb b/lib/datadog/tracing/contrib/sidekiq/configuration/settings.rb
@@ -39,7 +39,7 @@ class Settings < Contrib::Configuration::Settings
             option :service_name
             option :client_service_name
             option :error_handler do |o|
-              o.type :proc, nil: true
+              o.type :proc, nilable: true
               o.experimental_default_proc Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
             end
             option :quantize, default: {}, type: :hash

diff --git a/lib/datadog/tracing/contrib/sinatra/configuration/settings.rb b/lib/datadog/tracing/contrib/sinatra/configuration/settings.rb
@@ -20,7 +20,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :analytics_enabled do |o|
-              o.type :bool, nil: true
+              o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED
             end