this_feature 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8812767db56e7467a7439bc73bd243e3829974f9ee8897b85e434a036d0cdff9
-  data.tar.gz: b27419213f0bb1954a7d9c221ce315ae2229f2bb27fee13ae92b8987371d7c24
+  metadata.gz: 4a2e4f072c94b68b9a9e4675ac663f4d6f451d1d7c854e457079d539bd16184e
+  data.tar.gz: 6bbda6b3a7257f0a2e1ebd13784c3a78d4eb4ba3340727b99aa9d9df90753ea3
 SHA512:
-  metadata.gz: cc7fe3136ed720c6eca4aed7ee10a02faf9e3eca3f39302137f7b375e408bf7be7b6259e5fa6ab7b631d9c929fa6c562c25e697cc2ff061a0d204c982dc45a73
-  data.tar.gz: 6b7e73cead9d55c2c116c9fda04a61c789b2ab8c368d53535958f38f6fe8a7e1191842119e1c469d6d4459a55c4ad722dfdf2e24b9fb64ec95bcbcf5bc1ca36b
+  metadata.gz: 0c0e69e00abb16fc2e781b4fdeb63664af7705280095c1f0a12cb660c5195b886463195e0830c91382474f62cd5c9c0b777aeddb14b494f48040cc2522d238c9
+  data.tar.gz: 6b1e05ba21a6409f413ba5b11167f1c17e561a9c2989edde58a1b2f50d1c368c4b76fde8153db4588757d6e4bd93a0f9e36d2fa4874e7190fa8c4347699e9c53

data/Gemfile.lock

@@ -1,39 +1,38 @@
 PATH
   remote: .
   specs:
-    this_feature (0.7.0)
-    this_feature-adapters-flipper (0.7.0)
+    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.7.0)
+    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)
+    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.5.0)
+    faraday (1.7.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -41,6 +40,7 @@ GEM
       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 (>= 0.0.4)
     faraday-em_http (1.0.0)
@@ -48,21 +48,22 @@ GEM
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
     faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
+    faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
-    flipper (0.22.0)
-    flipper-active_record (0.22.0)
-      activerecord (>= 4.2, < 7)
-      flipper (~> 0.22.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.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)
@@ -73,7 +74,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rake (13.0.1)
-    redis (4.3.1)
+    redis (4.4.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -87,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)
@@ -104,7 +105,6 @@ GEM
     thread_safe (0.3.6)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -122,4 +122,4 @@ DEPENDENCIES
   this_feature-adapters-split_io!
 
 BUNDLED WITH
-   2.1.4
+   2.3.21

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,7 +14,7 @@ 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]
@@ -27,7 +27,7 @@ class ThisFeature
         !!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
 

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.7.0"
+  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.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Max Pleaner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler