strict 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b15e13a3f628809ea9410898b170658979f5e4c5a69b03a1ef4dcccad35e947f
-  data.tar.gz: b37173fddebaa55c744c20230548a80832a38c86e6bb4879f39d54a105fb5ddb
+  metadata.gz: 05af463032460cf8cf6cce2c976fe04a60315e8fcfba76984692ae5fe880dc23
+  data.tar.gz: 4c1668b6dc7282e128be060abd39f4b785a85857fa4648f14dbc2e22d745643c
 SHA512:
-  metadata.gz: 25bb591ed6df44c60f6e2c01f977f4fcb881b022e62af11adbcd32e4d15dd83bfbfd34a1f20139aa64b0de0e8447e8cdc9e73d6ff5ac5331ea1ef9cab81f1f7e
-  data.tar.gz: 46ddcaa771d227162e762d6bb424382c0efc3451d540340ad70a888842669ad8fb5969af11302d49ff5c5f5334852d44201be20253c399156373d9fd5d4c7ae8
+  metadata.gz: 442536f508b71231134f0bc291c12343d926737f53b8c8cb1ef575247ae4ac87435bba5a169bdda043daaa5e88c6ead88298520f824528903b1066d39dbf87a1
+  data.tar.gz: 81456be545bc010c0dac65fb3d2f9e390deb966c57b63032e81cf64a185a5268d0f14a40d6592c33db6793dc3bfb847548e76e6906ac7f9c4f8d6143a10f6151

data/Gemfile.lock

@@ -1,51 +1,51 @@
 PATH
   remote: .
   specs:
-    strict (1.4.0)
+    strict (1.5.0)
       zeitwerk (~> 2.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    debug (1.6.3)
-      irb (>= 1.3.6)
+    debug (1.7.2)
+      irb (>= 1.5.0)
       reline (>= 0.3.1)
     gem-release (2.2.2)
-    io-console (0.5.11)
-    irb (1.4.2)
+    io-console (0.6.0)
+    irb (1.6.4)
       reline (>= 0.3.0)
-    json (2.6.2)
-    minitest (5.16.3)
+    json (2.6.3)
+    minitest (5.18.0)
     minitest-spec-context (0.0.4)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
-    reline (0.3.1)
+    regexp_parser (2.7.0)
+    reline (0.3.3)
       io-console (~> 0.5)
     rexml (3.2.5)
-    rubocop (1.38.0)
+    rubocop (1.49.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
-      parser (>= 3.1.1.0)
-    rubocop-minitest (0.23.0)
-      rubocop (>= 0.90, < 2.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.30.0)
+      rubocop (>= 1.39, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.3.0)
-    zeitwerk (2.6.4)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.7)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -173,6 +173,54 @@ storage = Storage.new(Storages::Wat.new)
 # => Strict::ImplementationDoesNotConformError
 ```
 
+### Configuration
+
+Strict exposes some configuration options which can be configured globally via `Strict.configure { ... }` or overridden
+within a block via `Strict.with_overrides(...) { ... }`.
+
+#### Example
+
+```ruby
+# Globally
+
+Strict.configure do |c|
+  c.sample_rate = 0.75 # run validation ~75% of the time
+end
+
+Strict.configure do |c|
+  c.sample_rate = 0 # disable validation (Strict becomes Lenient)
+end
+
+Strict.configure do |c|
+  c.sample_rate = 0 # always run validation
+end
+
+# Locally within the block (only applies to the current thread)
+
+Strict.with_overrides(sample_rate: 0) do
+  # Use Strict as you normally would
+
+  Strict.with_overrides(sample_rate: 0.5) do
+    # Overrides can be nested
+  end
+end
+```
+
+#### `Strict.configuration.random`
+
+The instance of a `Random::Formatter` that Strict uses in tandom with the `sample_rate` to determine when validation
+should be checked.
+
+**Default**: `Random.new`
+
+#### `Strict.configuration.sample_rate`
+
+The rate of samples Strict will consider when validating attributes, parameters, and return values. A rate of 0.25 will
+validate roughly 25% of the time, a rate of 0 will disable validation entirely, and a rate of 1 will always
+run validations. The `sample_rate` is used in tandem with `random` to determine whether validation should be run.
+
+**Default**: 1
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/strict/attribute.rb

@@ -57,6 +57,8 @@ module Strict
     end
 
     def valid?(value)
+      return true unless Strict.configuration.validate?
+
       validator === value
     end
 

data/lib/strict/configuration.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Strict
+  class Configuration
+    attr_reader :random, :sample_rate
+
+    def initialize(random: nil, sample_rate: nil)
+      self.random = random || Random.new
+      self.sample_rate = sample_rate || 1
+    end
+
+    def random=(random)
+      case random
+      when Random::Formatter
+        @random = random
+      else
+        raise Strict::Error, "Expected a Random::Formatter, got: #{random.inspect}."
+      end
+    end
+
+    def sample_rate=(rate)
+      case rate
+      when 0..1
+        @sample_rate = rate
+      else
+        raise Strict::Error, "Expected a sample rate between 0 and 1 (inclusive), got: #{rate.inspect}. " \
+                             "A rate of 0 will disable strict validation. " \
+                             "A rate of 1 will validate 100% of the time. " \
+                             "A rate of 0.25 will validate roughly 25% of the time."
+      end
+    end
+
+    def validate?
+      sample_rate >= 1 || (sample_rate > 0 && random.rand < sample_rate) # rubocop:disable Style/NumericPredicate
+    end
+
+    def to_h
+      {
+        random: random,
+        sample_rate: sample_rate
+      }
+    end
+  end
+end

data/lib/strict/parameter.rb

@@ -56,6 +56,8 @@ module Strict
     end
 
     def valid?(value)
+      return true unless Strict.configuration.validate?
+
       validator === value
     end
 

data/lib/strict/return.rb

@@ -16,6 +16,8 @@ module Strict
     end
 
     def valid?(value)
+      return true unless Strict.configuration.validate?
+
       validator === value
     end
 

data/lib/strict/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Strict
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/strict.rb

@@ -6,4 +6,45 @@ loader.setup
 
 module Strict
   ISSUE_TRACKER = "https://github.com/kylekthompson/strict/issues"
+
+  class << self
+    def configuration
+      thread_configuration || global_configuration
+    end
+
+    def configure
+      raise Strict::Error, "cannot reconfigure overridden configuration" if overridden?
+
+      yield(configuration)
+    end
+
+    def with_overrides(**overrides)
+      original_thread_configuration = thread_configuration
+
+      begin
+        self.thread_configuration = Strict::Configuration.new(**configuration.to_h.merge(overrides))
+        yield
+      ensure
+        self.thread_configuration = original_thread_configuration
+      end
+    end
+
+    private
+
+    def overridden?
+      !!thread_configuration
+    end
+
+    def thread_configuration
+      Thread.current[:configuration]
+    end
+
+    def thread_configuration=(configuration)
+      Thread.current[:configuration] = configuration
+    end
+
+    def global_configuration
+      @global_configuration ||= Strict::Configuration.new
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strict
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Kyle Thompson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2023-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -164,6 +164,7 @@ files:
 - lib/strict/attributes/instance.rb
 - lib/strict/coercers/array.rb
 - lib/strict/coercers/hash.rb
+- lib/strict/configuration.rb
 - lib/strict/dsl/coercible.rb
 - lib/strict/dsl/validatable.rb
 - lib/strict/error.rb