this_feature 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e205e9b9a6a53ff76d8c93b315eb7e8cd2f05a96a9e7f4ae9ac434371155e9
-  data.tar.gz: 1e5e996c866d55076f205a47685e295e4b04f0373aa545d183c0192d640ac8a0
+  metadata.gz: 8812767db56e7467a7439bc73bd243e3829974f9ee8897b85e434a036d0cdff9
+  data.tar.gz: b27419213f0bb1954a7d9c221ce315ae2229f2bb27fee13ae92b8987371d7c24
 SHA512:
-  metadata.gz: 4ea504d76f8f435166ba50bb4643065030e40ea44626ffd4222fe60a5f80588d3242fe89dc339b14cce7b8cc1657fef016c9c59e5decdc9879f3bf64f23581b5
-  data.tar.gz: 523abe2a99278d2c559931e3b89ba0a946ca03f5e7a3fc92fd0e060555d0a0b25308d863f57904f4f4cc9ddb5fd93535e79bcee9164cff769b3d2ee61a6fcf0c
+  metadata.gz: cc7fe3136ed720c6eca4aed7ee10a02faf9e3eca3f39302137f7b375e408bf7be7b6259e5fa6ab7b631d9c929fa6c562c25e697cc2ff061a0d204c982dc45a73
+  data.tar.gz: 6b7e73cead9d55c2c116c9fda04a61c789b2ab8c368d53535958f38f6fe8a7e1191842119e1c469d6d4459a55c4ad722dfdf2e24b9fb64ec95bcbcf5bc1ca36b

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    this_feature (0.6.1)
-    this_feature-adapters-flipper (0.6.1)
+    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.6.1)
+    this_feature-adapters-split_io (0.7.0)
       splitclient-rb
       this_feature
 
@@ -27,27 +27,39 @@ GEM
     byebug (11.1.2)
     coderay (1.1.2)
     concurrent-ruby (1.1.8)
-    connection_pool (2.2.3)
+    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.3.0)
+    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)
-      ruby2_keywords
+      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)
-    flipper (0.20.3)
-    flipper-active_record (0.20.3)
-      activerecord (>= 5.0, < 7)
-      flipper (~> 0.20.3)
+    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.9)
       concurrent-ruby (~> 1.0)
     json (2.5.1)
-    jwt (2.2.2)
+    jwt (2.2.3)
     lru_redux (1.1.0)
     method_source (1.0.0)
     minitest (5.14.4)
@@ -61,7 +73,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rake (13.0.1)
-    redis (4.2.5)
+    redis (4.3.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)

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/lib/this_feature/adapters/memory.rb

@@ -19,11 +19,11 @@ class ThisFeature
 
         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
 
@@ -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/version.rb

@@ -1,3 +1,3 @@
 class ThisFeature
-  VERSION = "0.6.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.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Max Pleaner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -165,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Feature flag control