unleash 4.4.0 → 4.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5788566712ad3909e6707041673d359a4d9835b59c79bf0e0fac80c7c8a164ed
-  data.tar.gz: 707f6875e73a10ef24fdce900aa7c179b0762eedda07ce83a41ea5ed76ba494f
+  metadata.gz: e8461b30f4a58518d73731731a7dfbc32041a5a017362319b9d8ba76d2cecb98
+  data.tar.gz: '06098a3f106f50b0ddad46e17bef57584918ecbefe88486009d95edbdb546550'
 SHA512:
-  metadata.gz: 5d836f1c130e5db08fdac81f75cb938e93c060f997946ec80bd5819ad098a9b6d7a6d5628f88cd70144899bbe72ac1f5a1e802b4973b6ee0d24eda85e783fab3
-  data.tar.gz: 69280e8af54ba2613ef3ae17206f0dfbd31a958d2595162dab71dd0d4cf5815d4dc3e023160c1edc1dbcaeea77d2cfd5f2e468af28051fe41b51dd77fae0f689
+  metadata.gz: ec0644f3bd93de7f75b06e44c059d39ff3ed87af00ee7ca17d1ad3a3e444626f190c4e26863167b116eda85ce0c01196542f8167f4494052fdae9b3e3e09e15c
+  data.tar.gz: 11764caf8ccd33c757cbd282a5e5f3d6d6b9dc7b70c29c0e9e196b512be3c1baee10abb21279358e7c7001a91b3825d5c42661910695e74e9e1585e2003c9b58

data/.github/stale.yml

@@ -0,0 +1 @@
+_extends: .github

data/.github/workflows/pull_request.yml

@@ -28,8 +28,10 @@ jobs:
           - ubuntu
           - macos
         ruby-version:
-          - jruby-9.2
+          - jruby-9.4
           - jruby-9.3
+          - jruby-9.2
+          - 3.2
           - 3.1
           - '3.0'
           - 2.7
@@ -37,7 +39,7 @@ jobs:
           - 2.5
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:

data/.rubocop.yml

@@ -6,10 +6,11 @@ AllCops:
 Naming/PredicateName:
   AllowedMethods:
     - is_enabled?
+    - is_disabled?
 
 
 Metrics/ClassLength:
-  Max: 130
+  Max: 135
 Layout/LineLength:
   Max: 140
 Metrics/MethodLength:
@@ -22,7 +23,7 @@ Metrics/BlockLength:
 Metrics/AbcSize:
   Max: 30
 Metrics/CyclomaticComplexity:
-  Max: 9
+  Max: 10
 Metrics/PerceivedComplexity:
   Max: 10
 

data/README.md

@@ -10,11 +10,13 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 
 ## Supported Ruby Interpreters
 
+  * MRI 3.2
   * MRI 3.1
   * MRI 3.0
   * MRI 2.7
   * MRI 2.6
   * MRI 2.5
+  * jruby 9.4
   * jruby 9.3
   * jruby 9.2
 
@@ -23,7 +25,7 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 4.0.0'
+gem 'unleash', '~> 4.4.0'
 ```
 
 And then execute:
@@ -123,6 +125,12 @@ if @unleash.is_enabled?(feature_name, unleash_context)
 else
   puts " #{feature_name} is disabled according to unleash"
 end
+
+if @unleash.is_disabled?(feature_name, unleash_context)
+  puts " #{feature_name} is disabled according to unleash"
+else
+  puts " #{feature_name} is enabled according to unleash"
+end
 ```
 
 ## Usage in a Rails Application
@@ -302,6 +310,9 @@ Then wherever in your application that you need a feature toggle, you can use:
 if UNLEASH.is_enabled? "AwesomeFeature", @unleash_context
   puts "AwesomeFeature is enabled"
 end
+if UNLEASH.is_disabled? "AwesomeFeature", @unleash_context
+  puts "AwesomeFeature is disabled"
+end
 ```
 
 or if client is set in `Rails.configuration.unleash`:
@@ -310,6 +321,9 @@ or if client is set in `Rails.configuration.unleash`:
 if Rails.configuration.unleash.is_enabled? "AwesomeFeature", @unleash_context
   puts "AwesomeFeature is enabled"
 end
+if Rails.configuration.unleash.is_disabled? "AwesomeFeature", @unleash_context
+  puts "AwesomeFeature is enabled"
+end
 ```
 
 If the feature is not found in the server, it will by default return false.
@@ -443,6 +457,9 @@ Method Name | Description | Return Type |
 `is_enabled?` | Check if feature toggle is to be enabled or not. | Boolean |
 `enabled?` | Alias to the `is_enabled?` method. But more ruby idiomatic. | Boolean |
 `if_enabled` | Run a code block, if a feature is enabled. | `yield` |
+`is_disabled?` | Check if feature toggle is to be enabled or not. | Boolean |
+`disabled?` | Alias to the `is_disabled?` method. But more ruby idiomatic. | Boolean |
+`if_disabled` | Run a code block, if a feature is disabled. | `yield` |
 `get_variant` | Get variant for a given feature | `Unleash::Variant` |
 `shutdown` | Save metrics to disk, flush metrics to server, and then kill ToggleFetcher and MetricsReporter threads. A safe shutdown. Not really useful in long running applications, like web applications. | nil |
 `shutdown!` | Kill ToggleFetcher and MetricsReporter threads immediately. | nil |
@@ -475,7 +492,7 @@ This client comes with the all the required strategies out of the box:
 
 ## Custom Strategies
 
-Client allows to add [custom activation strategies](https://docs.getunleash.io/advanced/custom_activation_strategy) using configuration. 
+Client allows to add [custom activation strategies](https://docs.getunleash.io/advanced/custom_activation_strategy) using configuration.
 In order for strategy to work correctly it should support two methods `name` and `is_enabled?`
 
 ```ruby
@@ -483,7 +500,7 @@ class MyCustomStrategy
   def name
     'muCustomStrategy'
   end
-  
+
   def is_enabled?(params = {}, context = nil)
     true
   end
@@ -498,6 +515,12 @@ end
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+This SDK is also built against the Unleash Client Specification tests. To run the Ruby SDK against this test suite, you'll need to have a copy on your machine, you can clone the repository directly using:
+
+`git clone --depth 5 --branch v4.2.2 https://github.com/Unleash/client-specification.git client-specification`
+
+After doing this, `rake spec` will also run the client specification tests.
+
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 

data/lib/unleash/client.rb

@@ -50,14 +50,25 @@ module Unleash
       toggle.is_enabled?(context)
     end
 
+    def is_disabled?(feature, context = nil, default_value_param = true, &fallback_blk)
+      !is_enabled?(feature, context, !default_value_param, &fallback_blk)
+    end
+
     # enabled? is a more ruby idiomatic method name than is_enabled?
     alias enabled? is_enabled?
+    # disabled? is a more ruby idiomatic method name than is_disabled?
+    alias disabled? is_disabled?
 
     # execute a code block (passed as a parameter), if is_enabled? is true.
     def if_enabled(feature, context = nil, default_value = false, &blk)
       yield(blk) if is_enabled?(feature, context, default_value)
     end
 
+    # execute a code block (passed as a parameter), if is_disabled? is true.
+    def if_disabled(feature, context = nil, default_value = true, &blk)
+      yield(blk) if is_disabled?(feature, context, default_value)
+    end
+
     def get_variant(feature, context = Unleash::Context.new, fallback_variant = disabled_variant)
       Unleash.logger.debug "Unleash::Client.get_variant for feature: #{feature} with context #{context}"
 

data/lib/unleash/constraint.rb

@@ -43,6 +43,7 @@ module Unleash
 
     def matches_context?(context)
       Unleash.logger.debug "Unleash::Constraint matches_context? value: #{self.value} context.get_by_name(#{self.context_name})"
+      return false if context.nil?
 
       match = matches_constraint?(context)
       self.inverted ? !match : match

data/lib/unleash/context.rb

@@ -9,7 +9,7 @@ module Unleash
 
       self.app_name    = value_for('appName', params, Unleash&.configuration&.app_name)
       self.environment = value_for('environment', params, Unleash&.configuration&.environment || 'default')
-      self.user_id     = value_for('userId', params)
+      self.user_id     = value_for('userId', params)&.to_s
       self.session_id  = value_for('sessionId', params)
       self.remote_address = value_for('remoteAddress', params)
       self.current_time = value_for('currentTime', params, Time.now.utc.iso8601.to_s)

data/lib/unleash/feature_toggle.rb

@@ -37,12 +37,11 @@ module Unleash
 
       context = ensure_valid_context(context)
 
-      return Unleash::FeatureToggle.disabled_variant unless self.enabled && am_enabled?(context)
-      return Unleash::FeatureToggle.disabled_variant if sum_variant_defs_weights <= 0
-
-      variant = variant_from_override_match(context) || variant_from_weights(context, resolve_stickiness)
+      toggle_enabled = am_enabled?(context)
+      variant = resolve_variant(context, toggle_enabled)
 
-      Unleash.toggle_metrics.increment_variant(self.name, variant.name) unless Unleash.configuration.disable_metrics
+      choice = toggle_enabled ? :yes : :no
+      Unleash.toggle_metrics.increment_variant(self.name, choice, variant.name) unless Unleash.configuration.disable_metrics
       variant
     end
 
@@ -52,6 +51,13 @@ module Unleash
 
     private
 
+    def resolve_variant(context, toggle_enabled)
+      return Unleash::FeatureToggle.disabled_variant unless toggle_enabled
+      return Unleash::FeatureToggle.disabled_variant if sum_variant_defs_weights <= 0
+
+      variant_from_override_match(context) || variant_from_weights(context, resolve_stickiness)
+    end
+
     def resolve_stickiness
       self.variant_definitions&.map(&:stickiness)&.compact&.first || "default"
     end

data/lib/unleash/metrics.rb

@@ -1,33 +1,41 @@
 module Unleash
   class Metrics
-    attr_accessor :features
-
-    # NOTE: no mutexes for features
+    attr_accessor :features, :features_lock
 
     def initialize
       self.features = {}
+      self.features_lock = Mutex.new
     end
 
     def to_s
-      self.features.to_json
+      self.features_lock.synchronize do
+        return self.features.to_json
+      end
     end
 
     def increment(feature, choice)
       raise "InvalidArgument choice must be :yes or :no" unless [:yes, :no].include? choice
 
-      self.features[feature] = { yes: 0, no: 0 } unless self.features.include? feature
-      self.features[feature][choice] += 1
+      self.features_lock.synchronize do
+        self.features[feature] = { yes: 0, no: 0 } unless self.features.include? feature
+        self.features[feature][choice] += 1
+      end
     end
 
-    def increment_variant(feature, variant)
-      self.features[feature] = { yes: 0, no: 0 } unless self.features.include? feature
-      self.features[feature]['variant'] = {}     unless self.features[feature].include? 'variant'
-      self.features[feature]['variant'][variant] = 0 unless self.features[feature]['variant'].include? variant
-      self.features[feature]['variant'][variant] += 1
+    def increment_variant(feature, choice, variant)
+      self.features_lock.synchronize do
+        self.features[feature] = { yes: 0, no: 0 } unless self.features.include? feature
+        self.features[feature][choice] += 1
+        self.features[feature]['variant'] = {}     unless self.features[feature].include? 'variant'
+        self.features[feature]['variant'][variant] = 0 unless self.features[feature]['variant'].include? variant
+        self.features[feature]['variant'][variant] += 1
+      end
     end
 
     def reset
-      self.features = {}
+      self.features_lock.synchronize do
+        self.features = {}
+      end
     end
   end
 end

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "4.4.0".freeze
+  VERSION = "4.4.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.4.2
 platform: ruby
 authors:
 - Renato Arruda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2023-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -146,6 +146,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/stale.yml"
 - ".github/workflows/add-to-project.yml"
 - ".github/workflows/pull_request.yml"
 - ".gitignore"