this_feature 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6fdd8f4258c9cca45bdf31d7370e100eb9175102ba565f3368f23a83edf8d46
-  data.tar.gz: 79c1cbce63fad4511b3a5828fcc90cecb609db1abf2047c01270f7246c1631be
+  metadata.gz: 8812767db56e7467a7439bc73bd243e3829974f9ee8897b85e434a036d0cdff9
+  data.tar.gz: b27419213f0bb1954a7d9c221ce315ae2229f2bb27fee13ae92b8987371d7c24
 SHA512:
-  metadata.gz: b8cb49d96981b3320399c856fcd5367e54fc478c9af60e4bfacbf6d2a54a990fa89db7344e8e1b342cbb2a764e57c7b6ca3f7dddec0247fa6f6521250f40f565
-  data.tar.gz: b3804fb6eb9f37a12e2a8a477ed730ca83ed2cdf7d1a419c39b75ba1d9a4d9243051ee292dfdc59a5d68a2cb3a5d901a2606455916a6a0a22f2b73a5aab27c50
+  metadata.gz: cc7fe3136ed720c6eca4aed7ee10a02faf9e3eca3f39302137f7b375e408bf7be7b6259e5fa6ab7b631d9c929fa6c562c25e697cc2ff061a0d204c982dc45a73
+  data.tar.gz: 6b7e73cead9d55c2c116c9fda04a61c789b2ab8c368d53535958f38f6fe8a7e1191842119e1c469d6d4459a55c4ad722dfdf2e24b9fb64ec95bcbcf5bc1ca36b

data/Gemfile.lock

@@ -1,55 +1,70 @@
 PATH
   remote: .
   specs:
-    this_feature (0.5.0)
-    this_feature-adapters-flipper (0.5.0)
+    this_feature (0.7.0)
+    this_feature-adapters-flipper (0.7.0)
       flipper (~> 0.16)
       flipper-active_record (~> 0.16)
       this_feature
-    this_feature-adapters-split_io (0.5.0)
+    this_feature-adapters-split_io (0.7.0)
       splitclient-rb
       this_feature
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.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.6)
-    connection_pool (2.2.3)
+    concurrent-ruby (1.1.8)
+    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.0.1)
+    faraday (1.5.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)
       multipart-post (>= 1.2, < 3)
-    flipper (0.19.0)
-    flipper-active_record (0.19.0)
-      activerecord (>= 5.0, < 7)
-      flipper (~> 0.19.0)
-    gem-release (2.1.1)
+      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)
+    faraday-net_http_persistent (1.1.0)
+    faraday-patron (1.0.0)
+    flipper (0.22.0)
+    flipper-active_record (0.22.0)
+      activerecord (>= 4.2, < 7)
+      flipper (~> 0.22.0)
+    gem-release (2.2.1)
     hitimes (1.3.1)
-    i18n (1.8.5)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    json (2.3.1)
-    jwt (2.2.2)
+    json (2.5.1)
+    jwt (2.2.3)
     lru_redux (1.1.0)
     method_source (1.0.0)
-    minitest (5.14.1)
+    minitest (5.14.4)
     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 +73,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rake (13.0.1)
-    redis (4.2.2)
+    redis (4.3.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -72,23 +87,24 @@ 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.3)
       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)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

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/memory.md

@@ -4,7 +4,7 @@
 
 Under the hood, the memory adapter stores data in a dictionary like so:
 
-```
+```ruby
 {
   some_flag_name: {
     global: false,
@@ -41,7 +41,7 @@ ThisFeature.configure do |config|
 end
 ```
 
-The initializer takes an optional `context_key_method` argument. This is only relevant when using `context` - 
+The initializer takes an optional `context_key_method` argument. This is only relevant when using `context` -
 it specifies a method name which should be called on the context object to determine its identity.
 For example:
 
@@ -60,27 +60,29 @@ ThisFeature::Adapters::Memory.new(context_key_method: :this_feature_id)
 
 If this option is ommitted, then the context object uses its `self` as its "identity".
 
+**See below for example of how to use on! and off! from tests**
+
 ## API
 
 The Memory adapter supports the public API of `ThisFeature`.
 
-The `context` argument is supported, but not `data`.
-
-Read the following notes as well:
+### **#on? / #off?**
 
-- **on?** / **off?**: If passed a `context` argument, uses the aformentioned logic
+If passed a `context` argument, uses the aformentioned logic
 (`context_key_method`) to determine how it's handled.
 
-- **control?** is not yet implemented
-
-We also support two additional methods here that aren't present on the main adapter yet:
-
-- **on!** / **off!**
-
 Usage example of these:
 
-```
+```ruby
 # If you have configured the in-memory adapter as the default
 ThisFeature.test_adapter.on!(:flag_name, context: user) # with context
 ThisFeature.test_adapter.off!(:flag_name)               # without context
 ```
+
+### **#clear**
+
+Since the memory adapter stores flags in memory, it won't automatically get cleaned up in your tests. You can use this method to reset the memory adapter state.
+
+```ruby
+ThisFeature.test_adapter.clear
+```

data/docs/writing_an_adapter.md

@@ -1 +1,9 @@
-todo
+Look at [lib/this_feature/adapters/base.rb](../lib/this_feature/adapters/base.rb) to see the methods that your class should implement. 
+
+Make sure your class inherits from `ThisFeature::Adapters::Base` - this is a requirement. 
+
+You may define a custom `initialize` method - this isn't used by `this_feature` internals because we require an already-constructed instance to be passed into `ThisFeature.configure`. 
+
+For an example, look at one of the existing adapters: [lib/this_feature/adapters/](../lib/this_feature/adapters/)
+
+If you want to include your adapter in our README, just open up a PR.

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,24 +15,24 @@ 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]
 
-        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: {})
-        on_result = on?(flag_name, context: context)
-
-        return if on_result.nil?
+        !on?(flag_name, context: context, data: data)
+      end
 
-        !on_result
+      def control?(flag_name, **kwargs)
+        !present?(flag_name)
       end
 
       def on!(flag_name, context: nil, data: {})
@@ -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

@@ -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

@@ -7,6 +7,8 @@ class ThisFeature
     end
 
     def validate_adapters!
+      raise(NoAdaptersError.new) unless adapters.any?
+
       adapters.each do |adapter|
         raise BadAdapterError.new(adapter) unless adapter.class < Adapters::Base
       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.5.1"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: this_feature
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Max Pleaner
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,7 +150,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/hoverinc/this_feature
   source_code_uri: https://github.com/hoverinc/this_feature
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Feature flag control
 test_files: []