this_feature-adapters-flipper 0.4.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22af6aafd342c298c31378889d21f2f762b5ae5b96c36068a5297be4bb91cc3c
-  data.tar.gz: 67bfd16d7027c4c9ff4fe302bc559e2f3fffc68c54ef8b5dc374d174487ab53d
+  metadata.gz: 3710e3b7ca63182b688e5d869aae0da012e0a7cc62cca117f5eb88e5886298fe
+  data.tar.gz: 0b4ececf219ab511b50853856d1e62f010419f1aacbc9b50a3bd00bc3f4d706f
 SHA512:
-  metadata.gz: 40d04ebd41d2861ce29170706d6aff6d8da1455d190c592af2a133bf9fa0eaef778308a8eb5c75127d48e54aef79a6a1a2d35e31ca9662ee8e16a8f51dc3cee5
-  data.tar.gz: b8896633916796b3a01dc395e8b34c16c0c0051009f5ef8d2d04c313b3d99875da0130f823603c1818792a08417293ff7d4a18d36c3640da3651e57c1e91978c
+  metadata.gz: 56a00ef7e2cd7dfbf95c71f89776145e22001aaf9a43bf04c4f7c22ade02920d14f6face379ee29e4d3ab92bea61854d096ff94591cc60d679ac12cbf9e290e6
+  data.tar.gz: a6250717cde602636be9bdbc5687a71e96633490781008561ee6def906d7b01d0a9d17cb4eff8b37f7a6002538085311889ad7a1d2e9e8c7cc169c045576bb82

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    this_feature (0.4.0)
-    this_feature-adapters-flipper (0.4.0)
+    this_feature (0.5.3)
+    this_feature-adapters-flipper (0.5.3)
       flipper (~> 0.16)
       flipper-active_record (~> 0.16)
       this_feature
-    this_feature-adapters-split_io (0.4.0)
+    this_feature-adapters-split_io (0.5.3)
       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)
@@ -58,7 +58,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rake (13.0.1)
-    redis (4.2.1)
+    redis (4.2.2)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)

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

@@ -17,7 +17,7 @@ class ThisFeature
       end
 
       def control?(flag_name, context: UNDEFINED_KEY, data: {})
-        treatment(flag_name, context: context, data: data).eql?('control_treatment')
+        treatment(flag_name, context: context, data: data).include?('control')
       end
 
       def on?(flag_name, context: UNDEFINED_KEY, data: {})

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.0"
+  VERSION = "0.5.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: this_feature-adapters-flipper
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.3
 platform: ruby
 authors:
 - Max Pleaner
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: this_feature
@@ -85,7 +85,7 @@ homepage: http://hover.to
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -100,8 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: "[summary]"
 test_files: []