this_feature 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1038dc52ca2faa768e02dd16ac68f71551cad5405932575de6ffbb0be648896d
-  data.tar.gz: 9c930c96c3f67226b1a3eef72661320cb77cc275d0ac0fb69f8bd2342eddecf6
+  metadata.gz: 7a1fb53b4ceabfd85df7c059b02331d419259b23d7f0de2d90c942528bab1bbc
+  data.tar.gz: 81f8b34041e14e8d02c455c9c427c760b5d02ddf50531f016867f91bb7668368
 SHA512:
-  metadata.gz: 96c1151cc8dd148de9c5ba09e62cb1071b6cf18ce168145f07fa27cc4cf0075690deecd3326c6529966c74463bb088112bb8dd5bb5ad61d089a9a528318928af
-  data.tar.gz: b9c7ce61ee74dd0dbde08de215e72b8965fb9816a9a88cdfc0d68baa651db933d10801301a9ecb2f5de588d469870f2b479edc04a199f4aee71f94a28a0839d3
+  metadata.gz: 8eb7586c9d9b39cabe35d29257e79352f4eb807104f685fd23286717a6b358435c724bc194997b01bd8270d13de743374f763c6e32e4be355fa1db3c46caceb3
+  data.tar.gz: 3b0f23e8392bb6eb1eb52bf3858fb064aad0e59d5c5ef535e15ccb95acf88a974c64ae2ad32d0ee925e37b34ff55bf6b499e459593c656c7a01c5fee55712498

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    this_feature (0.9.0)
-    this_feature-adapters-flipper (0.9.0)
+    this_feature (0.10.0)
+    this_feature-adapters-flipper (0.10.0)
       flipper
       flipper-active_record
       this_feature
-    this_feature-adapters-split_io (0.9.0)
+    this_feature-adapters-split_io (0.10.0)
       splitclient-rb
       this_feature
 

data/README.md

@@ -98,6 +98,10 @@ bundle install && bundle exec rspec
 
 To write a new adapter, check the [Guide](./docs/writing_an_adapter.md).
 
+## Deployment
+
+If you are working at Hover, see [this confluence doc](https://hoverinc.atlassian.net/wiki/spaces/EN/pages/3149266988/deploying+this+feature+gem)
+
 ## License
 
 ThisFeature is released under the [MIT License](https://choosealicense.com/licenses/mit).

data/docs/memory.md

@@ -12,6 +12,13 @@ Under the hood, the memory adapter stores data in a dictionary like so:
       User1: true,
       User2: false
     }
+  },
+  some_flag_name_with_treatments: {
+    treatment_contexts: {
+      User1: 'treatment_name_1',
+      User2: 'treatment_name_2',
+      User3: 'treatment_name_3'
+    }
   }
 }
 ```
@@ -79,6 +86,47 @@ ThisFeature.test_adapter.on!(:flag_name, context: user) # with context
 ThisFeature.test_adapter.off!(:flag_name)               # without context
 ```
 
+### **#enable_treatment!**
+
+This method is useful when you need to enable a feature flag with a treatment (or multiple treatments), and not just `"on"` and `"off"`.
+
+Usage example of these:
+
+```ruby
+# If you have configured the in-memory adapter as the default
+ThisFeature.test_adapter.enable_treatment!(:flag_name, treatment: 'treatment_name', context: user)
+```
+#### This method requires 3 arguments:
+1. `flag_name`: String or Symbol (not a named argument)
+2. `treatment`: String
+3. `context`: User or Org object
+
+Per flag name, there can only be one treatment per `context_key` (the ID of object that is provided as `context`). So multiple calls with the same `context`, but different treatment names, will be overwritten.
+
+```ruby
+ThisFeature.test_adapter.enable_treatment!('flag_a', treatment: 'treatment_1', context: user1)
+ThisFeature.test_adapter.storage # => { 'flag_a' => { :treatment_contexts => { 'User1': 'treatment_1' } } }
+
+ThisFeature.test_adapter.enable_treatment!(:flag_a, treatment: 'treatment_2', context: user1)
+ThisFeature.test_adapter.storage # => { 'flag_a' => { :treatment_contexts => { 'User1': 'treatment_2' } } }
+```
+
+### **#treatment_value**
+
+You can retrieve the flag's treatment name for a specific context.
+
+Usage example of these:
+
+```ruby
+# If you have configured the in-memory adapter as the default
+ThisFeature.test_adapter.treatment_value(:flag_name, context: user)
+```
+
+#### This method requires 2 arguments:
+1. `flag_name`: String or Symbol (not a named argument)
+2. `context`: User or Org object
+
+When the Memory storage does not contain the given flag_name or if there is no provided `context`, `"control"` is returned. This is meant to mimic what SplitIO would return in the case of no configured treatment for the given `context`.
 ### **#clear**
 
 Since the memory adapter stores flags in memory, it won't automatically get cleaned up in your tests. You can use this method to reset the memory adapter state.

data/lib/this_feature/adapters/memory.rb

@@ -34,6 +34,26 @@ class ThisFeature
         !present?(flag_name)
       end
 
+      def treatment_value(flag_name, context: nil, data: {}, record: nil)
+        return 'control' if !present?(flag_name) || context.nil?
+
+        flag_data = storage[flag_name][:treatment_contexts]
+        context_registered = flag_data&.key?(context_key(context))
+
+        return 'control' if !flag_data || !context_registered
+
+        flag_data ||= {}
+        flag_data[context_key(context)]
+      end
+
+      def enable_treatment!(flag_name, treatment: nil, context: nil)
+        return false if treatment.nil? || flag_name.nil? || context.nil?
+
+        storage[flag_name] ||= {}
+        storage[flag_name][:treatment_contexts] ||= {}
+        storage[flag_name][:treatment_contexts][context_key(context)] = treatment
+      end
+
       def on!(flag_name, context: nil, data: {})
         storage[flag_name] ||= {}
 

data/lib/this_feature/adapters/split_io.rb

@@ -30,6 +30,14 @@ class ThisFeature
         treatment(flag_name, context: context, data: data, record: record).eql?('off')
       end
 
+      def treatment_value(flag_name, context: EMPTY_CONTEXT, data: {}, record: nil)
+        treatment_with_config(flag_name, context: context, data: data, record: record)[:treatment]
+      end
+
+      def treatment_config(flag_name, context: EMPTY_CONTEXT, data: {}, record: nil)
+        treatment_with_config(flag_name, context: context, data: data, record: record)[:config]
+      end
+
       private
 
       attr_reader :client, :context_key_method
@@ -39,6 +47,11 @@ class ThisFeature
         client.get_treatment(context_key(context), flag_name, base_data.merge(data))
       end
 
+      def treatment_with_config(flag_name, context: EMPTY_CONTEXT, data: {}, record: nil)
+        base_data = record ? ThisFeature.base_data_lambda.call(record) : {}
+        client.get_treatment_with_config(context_key(context), flag_name, base_data.merge(data))
+      end
+
       def context_key(context)
         return EMPTY_CONTEXT if context.nil? || context.eql?(EMPTY_CONTEXT)
         return context.send(context_key_method) unless context_key_method.nil?

data/lib/this_feature/flag.rb

@@ -21,5 +21,13 @@ class ThisFeature
     def control?
       adapter.control?(flag_name, context: context, data: data, record: record)
     end
+
+    def treatment_value
+      adapter.treatment_value(flag_name, context: context, data: data, record: record)
+    end
+
+    def treatment_config
+      adapter.treatment_config(flag_name, context: context, data: data, record: record)
+    end
   end
 end

data/lib/this_feature/version.rb

@@ -1,3 +1,3 @@
 class ThisFeature
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.10.0'.freeze
 end

data/this_feature-adapters-flipper.gemspec

@@ -10,17 +10,16 @@ Gem::Specification.new do |spec|
 
   spec.authors  = ['Max Pleaner', 'Matt Fong']
   spec.email    = ['maxpleaner@gmail.com', 'matthewjf@gmail.com']
-  spec.homepage = 'http://hover.to'
-
-  spec.metadata['homepage_uri']          = spec.homepage
-  spec.metadata['source_code_uri']       = spec.homepage
-  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.licenses    = ['MIT']
   spec.summary     = 'A ThisFeature adapter to Flipper'
   spec.description = ''
   spec.homepage    = 'https://github.com/hoverinc/this_feature'
 
+  spec.metadata['homepage_uri']          = spec.homepage
+  spec.metadata['source_code_uri']       = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
   spec.files         = Dir.glob('{bin/*,lib/**/*,[A-Z]*}')
   spec.platform      = Gem::Platform::RUBY
   spec.require_paths = ['lib']

data/this_feature-adapters-split_io.gemspec

@@ -10,17 +10,16 @@ Gem::Specification.new do |spec|
 
   spec.authors  = ['Max Pleaner', 'Matt Fong']
   spec.email    = ['maxpleaner@gmail.com', 'matthewjf@gmail.com']
-  spec.homepage = 'http://hover.to'
-
-  spec.metadata['homepage_uri']          = spec.homepage
-  spec.metadata['source_code_uri']       = spec.homepage
-  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.licenses    = ['MIT']
   spec.summary     = 'A ThisFeature adapter to Split.io'
   spec.description = ''
   spec.homepage    = 'https://github.com/hoverinc/this_feature'
 
+  spec.metadata['homepage_uri']          = spec.homepage
+  spec.metadata['source_code_uri']       = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
   spec.files         = Dir.glob('{bin/*,lib/**/*,[A-Z]*}')
   spec.platform      = Gem::Platform::RUBY
   spec.require_paths = ['lib']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: this_feature
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Max Pleaner
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email:
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A common interface to interact with many feature flag providers