this_feature-adapters-split_io 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cb0a20a6a7a888a624d86ca2e475d2b454ab83d38da2260f64bfde338e23372
-  data.tar.gz: 0c641b2a19a9d6f3712d8f18d8ff9001cadf4b7b48049f43e5ab3ea600c56b93
+  metadata.gz: 8a46929b3ddedeb9808f8fc356b67cfaec1884c3c4a02475b83ceda7b492068e
+  data.tar.gz: a522ef64174ce87ea9bcf235999b7e2037ab7f669d1045dadbc211e1b3978484
 SHA512:
-  metadata.gz: 5369ff715d49923f8bee08147b5d13c433c2579a02ceceafe960402b768c78c9ef384b6e13e28b760e370e054a2295c19f172cb3246516283d0035dce4266f10
-  data.tar.gz: cd4b17fb6004eb290eb4ecdd950afa72a7f8235d62d1bec9d16cffd032086951471fa315b68eb02b7a039bf4958889ce2463860f42a3b65aa460dd191d5c7a64
+  metadata.gz: 07dfc5e0b5b9174d02311779e5b168968ffd7ff86fd58e627b96d1a7dd3725b4d5ddcd6c7d002c893ce53ca6569fe6f7436150561c478989b02a57fe5b36c030
+  data.tar.gz: 62832ca8bb289e3f070ff0831cfb1c971b6a7f02f347a843947cca8d5e41a1e0b21e69ed0f298d86c6ec32bc915df6a64ebfb002315d7a3bf8e5c4c0c46c81a2

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.5.0)
+    this_feature-adapters-flipper (0.5.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.5.0)
       splitclient-rb
       this_feature
 
@@ -35,10 +35,10 @@ GEM
     diff-lcs (1.3)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    flipper (0.18.0)
-    flipper-active_record (0.18.0)
+    flipper (0.19.0)
+    flipper-active_record (0.19.0)
       activerecord (>= 5.0, < 7)
-      flipper (~> 0.18.0)
+      flipper (~> 0.19.0)
     gem-release (2.1.1)
     hitimes (1.3.1)
     i18n (1.8.5)

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) - **very helpful to 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/configuration.rb

@@ -1,7 +1,6 @@
-
 class ThisFeature
   class Configuration
-    attr_writer :adapters, :default_adapter
+    attr_writer :adapters, :default_adapter, :test_adapter
 
     def init
       validate_adapters!
@@ -20,5 +19,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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: this_feature-adapters-split_io
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Max Pleaner
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: this_feature