datadog-statsd-schema 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29e2a130f9456764b4cf8751421172e5c0798c7a4170c1e77dace308efea9649
-  data.tar.gz: 0ada9f736acfc7191017e514496a64e8303a3f9275d2521be3786e832c56b700
+  metadata.gz: f8ecccf4d0e55d1139596eca6ecfc41cf25a4bcd637aebdb4cb963150aa10ce7
+  data.tar.gz: 002504ebc4073bb7b34a5d979cb49f89d86e8eff5356594046bd3e1e223c8ed6
 SHA512:
-  metadata.gz: bd7083dd30216ee6cc3169d6831628485670547670c5afd3b374b0d46293032ab09c9d6af0e23480a3abd58d87c0920c93c29cb5dc34f106b33a2485ac168acd
-  data.tar.gz: 8bbf3a4de656164526a6c8293d806703d868c05efe61a54f78cde3528ebe27e8e93efb0bf3ff23041939ef7b60f256b66b288c0042310d7c3f9ecec686f3ac38
+  metadata.gz: b8f866b339297e39236ba1e546f50aff716f46e74d6856386a5de95ace0dfea5e62f060aec4e5e61320dd352a5d0bf971c38be4c7e9ee15ff17ea4b0083ad389
+  data.tar.gz: ff341e1836eebc261125c6cbd42103e359286bcb1bed0ed47fc96df9c2727f8873f6cd31e6e3591ca991b4b977fb9bdae42d5ef228eeebda7847da9129635ea9

data/.envrc

@@ -0,0 +1,2 @@
+PATH_add bin
+PATH_add exe

data/.rspec

@@ -1,3 +1,4 @@
---format documentation
+--format progress
 --color
 --require spec_helper
+-p 2

data/.rubocop.yml

@@ -6,6 +6,7 @@ plugins:
 AllCops:
   TargetRubyVersion: 3.1
   NewCops: enable
+  SuggestExtensions: false
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -18,3 +19,12 @@ Metrics/MethodLength:
 
 Metrics/BlockLength:
   Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,19 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-05-31 23:20:37 UTC using RuboCop version 1.75.8.
+# on 2025-06-06 22:59:19 UTC using RuboCop version 1.75.8.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-# Configuration parameters: EnforcedStyle, AllowedGems, Include.
-# SupportedStyles: Gemfile, gems.rb, gemspec
-# Include: **/*.gemspec, **/Gemfile, **/gems.rb
-Gemspec/DevelopmentDependencies:
-  Exclude:
-    - 'datadog-statsd-schema.gemspec'
-
 # Offense count: 4
 Lint/DuplicateMethods:
   Exclude:
@@ -24,20 +16,20 @@ Lint/FloatComparison:
   Exclude:
     - 'lib/datadog/statsd/emitter.rb'
 
-# Offense count: 8
+# Offense count: 14
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 48
+  Max: 54
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 356
+  Max: 369
 
-# Offense count: 6
+# Offense count: 8
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 21
+  Max: 20
 
 # Offense count: 5
 # Configuration parameters: CountComments, CountAsOne.
@@ -47,12 +39,12 @@ Metrics/ModuleLength:
 # Offense count: 2
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 7
+  Max: 8
 
-# Offense count: 5
+# Offense count: 6
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 20
+  Max: 19
 
 # Offense count: 3
 # This cop supports unsafe autocorrection (--autocorrect-all).
@@ -78,7 +70,6 @@ Naming/MethodParameterName:
 # MethodDefinitionMacros: define_method, define_singleton_method
 Naming/PredicateName:
   Exclude:
-    - 'spec/**/*'
     - 'lib/datadog/statsd/schema/namespace.rb'
 
 # Offense count: 4
@@ -88,10 +79,10 @@ RSpec/ContextWording:
   Exclude:
     - 'spec/datadog/statsd/schema/namespace_spec.rb'
 
-# Offense count: 15
+# Offense count: 19
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
-  Max: 19
+  Max: 36
 
 # Offense count: 4
 # Configuration parameters: Max, AllowedIdentifiers, AllowedPatterns.
@@ -105,9 +96,9 @@ RSpec/IndexedLet:
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 4
+# Offense count: 9
 RSpec/MultipleExpectations:
-  Max: 3
+  Max: 24
 
 # Offense count: 39
 # Configuration parameters: AllowSubject.
@@ -134,19 +125,20 @@ RSpec/VerifiedDoubles:
     - 'spec/datadog/statsd/schema/metric_definition_spec.rb'
     - 'spec/datadog/statsd/schema_spec.rb'
 
-# Offense count: 8
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: MinBranchesCount.
+Style/CaseLikeIf:
   Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/datadog/statsd/emitter.rb'
-    - 'lib/datadog/statsd/schema.rb'
-    - 'lib/datadog/statsd/schema/errors.rb'
-    - 'lib/datadog/statsd/schema/metric_definition.rb'
-    - 'lib/datadog/statsd/schema/namespace.rb'
-    - 'lib/datadog/statsd/schema/schema_builder.rb'
-    - 'lib/datadog/statsd/schema/tag_definition.rb'
+    - 'lib/datadog/statsd/schema/analyzer.rb'
+
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: format, sprintf, percent
+Style/FormatString:
+  Exclude:
+    - 'lib/datadog/statsd/schema/analyzer.rb'
 
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
@@ -154,8 +146,7 @@ Style/Documentation:
 # SupportedStyles: always, always_true, never
 Style/FrozenStringLiteralComment:
   Exclude:
-    - '**/*.arb'
-    - 'exe/datadog-statsd-schema'
+    - 'examples/schema/example_marathon.rb'
 
 # Offense count: 3
 # This cop supports unsafe autocorrection (--autocorrect-all).
@@ -171,10 +162,11 @@ Style/HashLikeCase:
   Exclude:
     - 'spec/datadog/statsd/schema/schema_builder_spec.rb'
 
-# Offense count: 3
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 Style/IfUnlessModifier:
   Exclude:
+    - 'examples/shared.rb'
     - 'lib/datadog/statsd/emitter.rb'
 
 # Offense count: 1
@@ -210,18 +202,11 @@ Style/SlicingWithRange:
   Exclude:
     - 'lib/datadog/statsd/schema/namespace.rb'
 
-# Offense count: 5
+# Offense count: 4
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, AllowComments.
-# AllowedMethods: define_method
+# AllowedMethods: define_method, mail, respond_to
 Style/SymbolProc:
   Exclude:
     - 'spec/datadog/statsd/schema/schema_builder_spec.rb'
     - 'spec/datadog/statsd/schema_spec.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 140

data/FUTURE_DIRECTION.md

@@ -0,0 +1,32 @@
+# Future Direction
+
+## Small Features & Improvements
+
+ * Validation mode: raise or log the error, but send the non-compliant metric anyway (good for migrations from raw statsd to `emitter`)
+
+## Large Features / Stories
+
+<dt>"The Service Registry" gem — <code>datadog-statsd-registry</code></dt>
+<dd>The gem would use <code>self.inherited</code> hook to auto-register each emitter and each schema in the global registry, to be recallable and searchable anywhere in the application code. This would encourage possible pre-declaration of most key emitters in a single initializer file, while still allowing ad-hoc creation, that does not get attached to the registry and will be garbage collected. Emitters are largely just a pre-determined combination of tags and a metric prefix, with a schema of allowable metrics and tags. It could be beneficial to reuse say <code>@email_stats_emitter</code> among multiple mailers in the system, but how to you get then to share an instance without some sort of a registry or IoC? Have schema and emmitter instances register by name in the global application space.<br/><br />
+
+Example:
+<pre>
+emitter = Datadog::Statsd.registry[:email_emitter]
+emitter.increment('total')
+</pre>
+</dd>
+
+<dt>Ensure Thread Safety for Emitter</dt>
+<dd>If emitters are to be shared, they necessarily must be thread safe, as should be the underlying <code>Datadog::Statsd</code></dd>
+
+### Multi-Gem Design
+
+ * Split `Datadog::Statsd::Emitter` class into its own gem, eg `datadog-statsd-emitter` without the schema. Allow emitter to receive a validator proc for extensions.
+ * Make this schema gem a validation extension to the emitter gem.
+
+Allow in the end a mix-match of:
+ * `datadog-statsd-emitter`
+ * `datadog-statsd-registry`
+ * `datadog-statsd-schema`
+
+