this_feature-adapters-flipper 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9156cd4072f7a42da3a841bacacb32ecb87b01e2ea67d5fb2f793cf531276223
-  data.tar.gz: d9818a598cc91d4190b3f29a03b0ee1cce98a2206f059c017f310baaf29b024f
+  metadata.gz: 9e4a26fde4d195b60dbd8eeb857a773257de6b5f8779347988035e74380e3e9b
+  data.tar.gz: 3ded8c80f4d943b08c7b3a9f769caaa6bf53940acceb5fd519d049e67331c10d
 SHA512:
-  metadata.gz: e54cd280974cef9b688bbf4dce7de1831e99f152856872f97b3a14de7bd68c6108965e2894ce600af36e45f53a97fcee8d6565a0e1b085f64663570646f4c96d
-  data.tar.gz: 59852a79b60b4bca12f1bfc6e145cb6348d348e6b4ad377f5971baa160bc3586570b3c145be99936d4200a411a5c2d5db43b4801a76c8e1d9c8e56f1ee4e44cb
+  metadata.gz: aafaf413f0a4dd23db4fde7c982c2faa91fee7449763cbfb39ef9edef28e5737c8cb8e1f26ab340a369d4109faa71415449d5e172121e5465e3c7fcc067529f4
+  data.tar.gz: 2cc0debacbf86eab5b03ef7bce12636f5d1bfb04f71f477c358ac256ba6ebefc75bae460b234eac9de43a2da25010c98c41b52464b5c7507e36a1787c816c878

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    this_feature (0.4.1)
-    this_feature-adapters-flipper (0.4.1)
+    this_feature (0.6.0)
+    this_feature-adapters-flipper (0.6.0)
       flipper (~> 0.16)
       flipper-active_record (~> 0.16)
       this_feature
-    this_feature-adapters-split_io (0.4.1)
+    this_feature-adapters-split_io (0.6.0)
       splitclient-rb
       this_feature
 
@@ -33,23 +33,26 @@ GEM
       activerecord
       database_cleaner (~> 1.8.0)
     diff-lcs (1.3)
-    faraday (1.0.1)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    flipper (0.18.0)
-    flipper-active_record (0.18.0)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    flipper (0.20.3)
+    flipper-active_record (0.20.3)
       activerecord (>= 5.0, < 7)
-      flipper (~> 0.18.0)
+      flipper (~> 0.20.3)
     gem-release (2.1.1)
     hitimes (1.3.1)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    json (2.3.1)
+    json (2.5.1)
     jwt (2.2.2)
     lru_redux (1.1.0)
     method_source (1.0.0)
     minitest (5.14.1)
     multipart-post (2.1.1)
-    net-http-persistent (4.0.0)
+    net-http-persistent (4.0.1)
       connection_pool (~> 2.2)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -58,7 +61,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rake (13.0.1)
-    redis (4.2.2)
+    redis (4.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -72,16 +75,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    ruby2_keywords (0.0.4)
     socketry (0.5.1)
       hitimes (~> 1.2)
-    splitclient-rb (7.1.3)
+    splitclient-rb (7.2.2)
       concurrent-ruby (~> 1.0)
       faraday (>= 0.8)
       json (>= 1.8)
       jwt (>= 2.2.1)
       lru_redux
       net-http-persistent (>= 2.9)
-      redis (>= 3.2)
+      redis (>= 4.2.2)
       socketry (~> 0.5.1)
       thread_safe (>= 0.3)
     sqlite3 (1.4.2)

data/README.md

@@ -1,65 +1,44 @@
 # ThisFeature
 
-The purpose of ThisFeature is to have one way to use feature flags
+**A common interface to interact with many feature flag providers.**
 
-## Installation
+Can be used to more easily migrate among providers.
+
+If your code uses ThisFeature,
+then you can just swap out the adapter without having to do a bunch of find-and-replace.
 
-Add this line to your application's `Gemfile`:
+## Installation
 
 ```ruby
 gem 'this_feature'
 ```
 
-And then execute:
-
-```sh
-bundle
-```
-
-Or install it yourself as:
-
-```sh
-gem install this_feature
-```
-
 ## Configuration
 
 ```ruby
 # config/initializers/this_feature.rb
 require 'this_feature'
+require 'this_feature/adapters/memory'
 
 ThisFeature.configure do |config|
-  config.adapters = [ThisFeature::Adapters::Memory]
-  config.default_adapter = config.adapters.first
+  adapter = ThisFeature::Adapters::Memory.new
+  config.adapters = [adapter]
+  config.default_adapter = adapter
 end
 ```
 
 **NOTE**: When searching for the presence of a flag, adapters are queried in order. The default adapter is the fallback adapter used when a flag isn't present in any of the adapters.
 
-
-### With Flipper
-
-```ruby
-# config/initializers/this_feature.rb
-require 'this_feature/adapters/flipper'
-
-ThisFeature.configure do |config|
-  config.adapters = [ThisFeature::Adapters::Flipper]
-  config.default_adapter = config.adapters.first
-end
-```
-
-
-
 ## Usage
 
 ### Flags
+
 ```ruby
-ThisFeature.flag('flag_name').on? # check if flag is turned on
-ThisFeature.flag('flag_name').off? # check if flag is turned off
-ThisFeature.flag('flag_name').control? # see if the adapter is using the control
-ThisFeature.flag('flag_name').on! # turn on the flag
-ThisFeature.flag('flag_name').off! # turn off the flag
+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.default_adapter            # access the default adapter directly if needed
 ```
 
 ### Context
@@ -78,8 +57,13 @@ In case context is not sufficient, you can also pass a data hash.
 ThisFeature.flag('flag_name', context: context, data: { org_id: 1 }).on?
 ```
 
-## TODO: Write documentation for the adapters (creating adapters, using memory adapter, using flipper adapter)
+## Available Adapters
+
+These adapters do behave slightly differently, so make sure to read the following docs:
 
+- [Flipper adapter](./docs/flipper.md)
+- [Split.io adapter](./docs/splitio.md)
+- [Memory adapter](./docs/memory.md) - **designed for use in tests**
 
 ## Development
 
@@ -90,6 +74,11 @@ You can run the tests with these commands in your Terminal:
 bundle install && bundle exec rspec
 ```
 
+To write a new adapter, check the [Guide](./docs/writing_an_adapter.md).
+
 ## License
 
 ThisFeature is released under the [MIT License](https://choosealicense.com/licenses/mit).
+
+
+

data/lib/this_feature.rb

@@ -34,4 +34,8 @@ class ThisFeature
   def self.adapters
     configuration.adapters
   end
+
+  def self.test_adapter
+    configuration.test_adapter
+  end
 end

data/lib/this_feature/adapters/base.rb

@@ -1,11 +1,6 @@
 class ThisFeature
   module Adapters
     class Base
-
-      def setup
-        raise UnimplementedError.new(self, __method__)
-      end
-
       def present?(flag_name)
         raise UnimplementedError.new(self, __method__)
       end

data/lib/this_feature/adapters/flipper.rb

@@ -19,17 +19,11 @@ class ThisFeature
       end
 
       def on?(flag_name, context: nil, data: {})
-        return unless present?(flag_name)
-
         client[flag_name].enabled?(*[context].compact)
       end
 
       def off?(flag_name, context: nil, data: {})
-        on_result = on?(flag_name, context: context)
-
-        return if on_result.nil?
-
-        !on_result
+        !on?(flag_name, context: context)
       end
 
       private

data/lib/this_feature/adapters/memory.rb

@@ -15,7 +15,7 @@ class ThisFeature
       end
 
       def on?(flag_name, context: nil, data: {})
-        return unless present?(flag_name)
+        return false unless present?(flag_name)
 
         flag_data = storage[flag_name]
 
@@ -28,11 +28,7 @@ class ThisFeature
       end
 
       def off?(flag_name, context: nil, data: {})
-        on_result = on?(flag_name, context: context)
-
-        return if on_result.nil?
-
-        !on_result
+        !on?(flag_name, context: context, data: data)
       end
 
       def on!(flag_name, context: nil, data: {})

data/lib/this_feature/adapters/split_io.rb

@@ -6,8 +6,9 @@ class ThisFeature
       # used as treatment key when none is given, it's required by split
       UNDEFINED_KEY = 'undefined_key'
 
-      def initialize(client: nil)
+      def initialize(client: nil, context_key_method: nil)
         @client = client || default_split_client
+        @context_key_method = context_key_method
 
         @client.block_until_ready
       end
@@ -30,18 +31,18 @@ class ThisFeature
 
       private
 
-      attr_reader :client
+      attr_reader :client, :context_key_method
 
       def treatment(flag_name, context: UNDEFINED_KEY, data: {})
-        key = if context.nil?
-          UNDEFINED_KEY
-        elsif context.respond_to?(:to_s)
-          context.to_s
-        else
-          context
-        end
-
-        client.get_treatment(key, flag_name, data)
+        client.get_treatment(context_key(context), flag_name, data)
+      end
+
+      def context_key(context)
+        return UNDEFINED_KEY if context.nil? || context.eql?(UNDEFINED_KEY)
+        return context.send(context_key_method) unless context_key_method.nil?
+        return context.to_s if context.respond_to?(:to_s)
+
+        context
       end
 
       def default_split_client

data/lib/this_feature/configuration.rb

@@ -1,13 +1,14 @@
-
 class ThisFeature
   class Configuration
-    attr_writer :adapters, :default_adapter
+    attr_writer :adapters, :default_adapter, :test_adapter
 
     def init
       validate_adapters!
     end
 
     def validate_adapters!
+      raise(NoAdaptersError.new) unless adapters.any?
+
       adapters.each do |adapter|
         raise BadAdapterError.new(adapter) unless adapter.class < Adapters::Base
       end
@@ -20,5 +21,9 @@ class ThisFeature
     def default_adapter
       @default_adapter ||= adapters.first
     end
+
+    def test_adapter
+      @test_adapter ||= Adapters::Memory.new
+    end
   end
 end

data/lib/this_feature/errors.rb

@@ -14,9 +14,9 @@ class ThisFeature
     end
   end
 
-  class NoWriteAdapter < Error
+  class NoAdaptersError < Error
     def initialize
-      super("Use the `ThisFeature.write_adapter=` setter before calling #enable or #disable")
+      super("No adapters configured.")
     end
   end
 

data/lib/this_feature/version.rb

@@ -1,3 +1,3 @@
 class ThisFeature
-  VERSION = "0.4.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: this_feature-adapters-flipper
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Max Pleaner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: this_feature