this_feature 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e205e9b9a6a53ff76d8c93b315eb7e8cd2f05a96a9e7f4ae9ac434371155e9
-  data.tar.gz: 1e5e996c866d55076f205a47685e295e4b04f0373aa545d183c0192d640ac8a0
+  metadata.gz: 4a2e4f072c94b68b9a9e4675ac663f4d6f451d1d7c854e457079d539bd16184e
+  data.tar.gz: 6bbda6b3a7257f0a2e1ebd13784c3a78d4eb4ba3340727b99aa9d9df90753ea3
 SHA512:
-  metadata.gz: 4ea504d76f8f435166ba50bb4643065030e40ea44626ffd4222fe60a5f80588d3242fe89dc339b14cce7b8cc1657fef016c9c59e5decdc9879f3bf64f23581b5
-  data.tar.gz: 523abe2a99278d2c559931e3b89ba0a946ca03f5e7a3fc92fd0e060555d0a0b25308d863f57904f4f4cc9ddb5fd93535e79bcee9164cff769b3d2ee61a6fcf0c
+  metadata.gz: 0c0e69e00abb16fc2e781b4fdeb63664af7705280095c1f0a12cb660c5195b886463195e0830c91382474f62cd5c9c0b777aeddb14b494f48040cc2522d238c9
+  data.tar.gz: 6b1e05ba21a6409f413ba5b11167f1c17e561a9c2989edde58a1b2f50d1c368c4b76fde8153db4588757d6e4bd93a0f9e36d2fa4874e7190fa8c4347699e9c53

data/Gemfile.lock

@@ -1,56 +1,69 @@
 PATH
   remote: .
   specs:
-    this_feature (0.6.1)
-    this_feature-adapters-flipper (0.6.1)
+    this_feature (0.8.0)
+    this_feature-adapters-flipper (0.8.0)
       flipper (~> 0.16)
       flipper-active_record (~> 0.16)
       this_feature
-    this_feature-adapters-split_io (0.6.1)
+    this_feature-adapters-split_io (0.8.0)
       splitclient-rb
       this_feature
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     byebug (11.1.2)
     coderay (1.1.2)
-    concurrent-ruby (1.1.8)
-    connection_pool (2.2.3)
+    concurrent-ruby (1.1.10)
+    connection_pool (2.2.5)
     database_cleaner (1.8.4)
     database_cleaner-active_record (1.8.0)
       activerecord
       database_cleaner (~> 1.8.0)
     diff-lcs (1.3)
-    faraday (1.3.0)
+    faraday (1.7.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
       faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
     faraday-net_http (1.0.1)
-    flipper (0.20.3)
-    flipper-active_record (0.20.3)
-      activerecord (>= 5.0, < 7)
-      flipper (~> 0.20.3)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    flipper (0.25.0)
+    flipper-active_record (0.25.0)
+      activerecord (>= 4.2, < 8)
+      flipper (~> 0.25.0)
     gem-release (2.2.1)
     hitimes (1.3.1)
-    i18n (1.8.9)
+    i18n (1.11.0)
       concurrent-ruby (~> 1.0)
     json (2.5.1)
-    jwt (2.2.2)
+    jwt (2.2.3)
     lru_redux (1.1.0)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.16.2)
     multipart-post (2.1.1)
     net-http-persistent (4.0.1)
       connection_pool (~> 2.2)
@@ -61,7 +74,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rake (13.0.1)
-    redis (4.2.5)
+    redis (4.4.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -75,10 +88,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
     socketry (0.5.1)
       hitimes (~> 1.2)
-    splitclient-rb (7.2.3)
+    splitclient-rb (7.3.1)
       concurrent-ruby (~> 1.0)
       faraday (>= 0.8)
       json (>= 1.8)
@@ -92,7 +105,6 @@ GEM
     thread_safe (0.3.6)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -110,4 +122,4 @@ DEPENDENCIES
   this_feature-adapters-split_io!
 
 BUNDLED WITH
-   2.1.4
+   2.3.21

data/README.md

@@ -2,17 +2,27 @@
 
 **A common interface to interact with many feature flag providers.**
 
-Can be used to more easily migrate among providers.
+ThisFeature can be used to more easily migrate from one feature flag service to another
 
 If your code uses ThisFeature,
-then you can just swap out the adapter without having to do a bunch of find-and-replace.
+then you can just swap out the vendor adapter without needing to do a bunch of find-and-replace in your codebase
+from one vendor's class/method signature to the another's.
 
 ## Installation
 
+Add ThisFeature to your `Gemfile`:
+
 ```ruby
+# Gemfile
 gem 'this_feature'
 ```
 
+Then from your Rails app's root directory:
+
+```sh
+bundle install
+```
+
 ## Configuration
 
 ```ruby
@@ -36,14 +46,13 @@ end
 ```ruby
 ThisFeature.flag('flag_name').on?      # is the flag is turned on?
 ThisFeature.flag('flag_name').off?     # is the flag is turned off?
-ThisFeature.flag('flag_name').control? # is the adapter is using the control?
-ThisFeature.flag('flag_name').present? # is the flag set at all?
+ThisFeature.flag('flag_name').control? # is the adapter using the control?
 ThisFeature.default_adapter            # access the default adapter directly if needed
 ```
 
 ### Context
 
-You can also pass a context to the flag, many feature flagging systems support this.
+You can also pass a `context` to the flag, many feature flagging systems support this.
 
 ```ruby
 ThisFeature.flag('flag_name', context: current_user).on?
@@ -51,12 +60,17 @@ ThisFeature.flag('flag_name', context: current_user).on?
 
 ### Data
 
-In case context is not sufficient, you can also pass a data hash.
+In case `context` is not sufficient, you can also pass a `data` hash.
 
 ```ruby
 ThisFeature.flag('flag_name', context: context, data: { org_id: 1 }).on?
 ```
 
+### Avoid Pitfalls
+
+1. If your flag has context-specific rules (e.g. on for some orgs, off for others), make sure that the code does a context-specific check. `ThisFeature.flag("flag_name").on?` may return true, while `ThisFeature.flag("flag_name", context: Org.first).on?` would return false. 
+2. Related to the previous bullet point, if you are checking whether a flag is "globally enabled" (and thus may be removed from the codebase), do not just use `ThisFeature.flag("flag_name").on?`, it won't tell you the whole story.  Go to the vendor console and check whether there are context-specific rules enabled.
+
 ## Available Adapters
 
 These adapters do behave slightly differently, so make sure to read the following docs:
@@ -65,6 +79,16 @@ These adapters do behave slightly differently, so make sure to read the followin
 - [Split.io adapter](./docs/splitio.md)
 - [Memory adapter](./docs/memory.md) - **designed for use in tests**
 
+### Needed Adapters
+
+We'd like to add more adapters for more vendors.
+If you're using a different backend and write your own adapter,
+please submit a pull request to upstream that adaptor into this repo.
+
+- Launch Darkly
+- YAML files
+- ...
+
 ## Development
 
 The tests are a good reflection of the current development state.

data/docs/splitio.md

@@ -32,4 +32,31 @@ The SplitIo adapter supports the public API of `ThisFeature`.
 
 Both `context` and `data` are supported.
 
-`control` is a native Split feature, so we perform a query to Split to get this info.
+`control` is a native Split feature, so we perform a query to Split to get this info.
+
+We've also added `record`, which is a helper to easily and consistently add
+attributes to the `data` hash. To take advantage of this, the application must
+set a `base_data_lambda` in the config. An example—
+```ruby
+ThisFeature.configure do |config|
+  config.base_data_lambda = -> (record) do
+    case record
+    when Org
+      {
+        org_id: record.id,
+        org_name: record.name
+      }
+    when User
+      {
+        org_id: record.org.id,
+        org_name: record.org.name,
+        user_email: record.email,
+        user_id: record.id,
+        user_name: record.name,
+      }
+    end
+  end
+end
+```
+Then `ThisFeature.flag("my-flag", record: user).on?` will automatically include
+org_id, org_name, user_email, user_id, and user_name in the data attributes.

data/lib/this_feature/adapters/base.rb

@@ -5,11 +5,11 @@ class ThisFeature
         raise UnimplementedError.new(self, __method__)
       end
 
-      def on?(flag_name, context: nil, data: {})
+      def on?(flag_name, context: nil, data: {}, record: nil)
         raise UnimplementedError.new(self, __method__)
       end
 
-      def off?(flag_name, context: nil, data: {})
+      def off?(flag_name, context: nil, data: {}, record: nil)
         raise UnimplementedError.new(self, __method__)
       end
 

data/lib/this_feature/adapters/flipper.rb

@@ -18,11 +18,11 @@ class ThisFeature
         !present?(flag_name)
       end
 
-      def on?(flag_name, context: nil, data: {})
+      def on?(flag_name, context: nil, data: {}, record: nil)
         client[flag_name].enabled?(*[context].compact)
       end
 
-      def off?(flag_name, context: nil, data: {})
+      def off?(flag_name, context: nil, data: {}, record: nil)
         !on?(flag_name, context: context)
       end
 

data/lib/this_feature/adapters/memory.rb

@@ -14,20 +14,20 @@ class ThisFeature
         !storage[flag_name].nil?
       end
 
-      def on?(flag_name, context: nil, data: {})
+      def on?(flag_name, context: nil, data: {}, record: nil)
         return false unless present?(flag_name)
 
         flag_data = storage[flag_name]
 
-        return true if flag_data[:global]
-        return false if context.nil?
+        context_registered = flag_data[:contexts]&.key?(context_key(context))
 
-        flag_data[:contexts] ||= {}
+        return !!flag_data[:global] if !context || (context && !context_registered)
 
+        flag_data[:contexts] ||= {}
         !!flag_data[:contexts][context_key(context)]
       end
 
-      def off?(flag_name, context: nil, data: {})
+      def off?(flag_name, context: nil, data: {}, record: nil)
         !on?(flag_name, context: context, data: data)
       end
 
@@ -62,6 +62,7 @@ class ThisFeature
       attr_reader :context_key_method
 
       def context_key(context)
+        return nil unless context
         return context if context_key_method.nil?
 
         context.send(context_key_method)

data/lib/this_feature/adapters/split_io.rb

@@ -3,8 +3,9 @@ require 'splitclient-rb'
 class ThisFeature
   module Adapters
     class SplitIo < Base
-      # used as treatment key when none is given, it's required by split
-      UNDEFINED_KEY = 'undefined_key'
+      # Used as the context key when none is given. This arg is required by
+      # Split, but it's nice not to have to pass it when the context is empty.
+      EMPTY_CONTEXT = 'undefined_key'
 
       def initialize(client: nil, context_key_method: nil)
         @client = client || default_split_client
@@ -17,28 +18,29 @@ class ThisFeature
         !control?(flag_name)
       end
 
-      def control?(flag_name, context: UNDEFINED_KEY, data: {})
-        treatment(flag_name, context: context, data: data).include?('control')
+      def control?(flag_name, context: EMPTY_CONTEXT, data: {}, record: nil)
+        treatment(flag_name, context: context, data: data, record: record).include?('control')
       end
 
-      def on?(flag_name, context: UNDEFINED_KEY, data: {})
-        treatment(flag_name, context: context, data: data).eql?('on')
+      def on?(flag_name, context: EMPTY_CONTEXT, data: {}, record: nil)
+        treatment(flag_name, context: context, data: data, record: record).eql?('on')
       end
 
-      def off?(flag_name, context: UNDEFINED_KEY, data: {})
-        treatment(flag_name, context: context, data: data).eql?('off')
+      def off?(flag_name, context: EMPTY_CONTEXT, data: {}, record: nil)
+        treatment(flag_name, context: context, data: data, record: record).eql?('off')
       end
 
       private
 
       attr_reader :client, :context_key_method
 
-      def treatment(flag_name, context: UNDEFINED_KEY, data: {})
-        client.get_treatment(context_key(context), flag_name, data)
+      def treatment(flag_name, context: EMPTY_CONTEXT, data: {}, record: nil)
+        base_data = record ? ThisFeature.base_data_lambda.call(record) : {}
+        client.get_treatment(context_key(context), flag_name, base_data.merge(data))
       end
 
       def context_key(context)
-        return UNDEFINED_KEY if context.nil? || context.eql?(UNDEFINED_KEY)
+        return EMPTY_CONTEXT if context.nil? || context.eql?(EMPTY_CONTEXT)
         return context.send(context_key_method) unless context_key_method.nil?
         return context.to_s if context.respond_to?(:to_s)
 

data/lib/this_feature/configuration.rb

@@ -1,6 +1,6 @@
 class ThisFeature
   class Configuration
-    attr_writer :adapters, :default_adapter, :test_adapter
+    attr_writer :adapters, :default_adapter, :test_adapter, :base_data_lambda
 
     def init
       validate_adapters!
@@ -25,5 +25,9 @@ class ThisFeature
     def test_adapter
       @test_adapter ||= Adapters::Memory.new
     end
+
+    def base_data_lambda
+      @base_data_lambda ||= -> (record) { {} }
+    end
   end
 end

data/lib/this_feature/flag.rb

@@ -1,24 +1,25 @@
 class ThisFeature
   class Flag
-    attr_reader :flag_name, :context, :data, :adapter
+    attr_reader :flag_name, :context, :data, :adapter, :record
 
-    def initialize(flag_name, adapter:, context: nil, data: {})
+    def initialize(flag_name, adapter:, context: nil, data: {}, record: nil)
       @flag_name = flag_name
       @adapter = adapter
       @context = context
       @data = data
+      @record = record
     end
 
     def on?
-      adapter.on?(flag_name, context: context, data: data)
+      adapter.on?(flag_name, context: context, data: data, record: record)
     end
 
     def off?
-      adapter.off?(flag_name, context: context, data: data)
+      adapter.off?(flag_name, context: context, data: data, record: record)
     end
 
     def control?
-      adapter.control?(flag_name, context: context, data: data)
+      adapter.control?(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.6.1"
+  VERSION = "0.8.0"
 end

data/lib/this_feature.rb

@@ -5,13 +5,13 @@ require 'this_feature/configuration'
 require 'this_feature/flag'
 
 class ThisFeature
-  def self.flag(flag_name, context: nil, data: {})
-    adapter = adapter_for(flag_name, context: nil, data: {})
+  def self.flag(flag_name, context: nil, data: {}, record: nil)
+    adapter = adapter_for(flag_name)
 
-    Flag.new(flag_name, adapter: adapter, context: context, data: data)
+    Flag.new(flag_name, adapter: adapter, context: context, data: data, record: record)
   end
 
-  def self.adapter_for(flag_name, context: nil, data: {})
+  def self.adapter_for(flag_name)
     matching_adapter = adapters.find do |adapter|
       adapter.present?(flag_name)
     end
@@ -38,4 +38,8 @@ class ThisFeature
   def self.test_adapter
     configuration.test_adapter
   end
+
+  def self.base_data_lambda
+    configuration.base_data_lambda
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: this_feature
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Max Pleaner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -165,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Feature flag control