this_feature 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1ce587cdd7e38a631ec48ebec63a3de11bd96ed5c82abff3b4486a0b09c0f11
-  data.tar.gz: 19643b3951c2483fdf3694073c24cbc71a530997a5192c58ea8a9c835b8c39cf
+  metadata.gz: 03e205e9b9a6a53ff76d8c93b315eb7e8cd2f05a96a9e7f4ae9ac434371155e9
+  data.tar.gz: 1e5e996c866d55076f205a47685e295e4b04f0373aa545d183c0192d640ac8a0
 SHA512:
-  metadata.gz: 132cb856e2bfb0af4b334bde04a7cce7586a15a3c6a0ffc5a0dde71725cc388deef03b21fc67d1a9f174e950676c832e99b8dbcd7211f187e8864b6918f944c3
-  data.tar.gz: 16a4c927b80d69a40b5104cb9e7d284c0da6423ddac78c89ce6a9b2394cade377f7c981c51f864c9c3fe506e119894081d6215d60f0273592912fbefa5a3892b
+  metadata.gz: 4ea504d76f8f435166ba50bb4643065030e40ea44626ffd4222fe60a5f80588d3242fe89dc339b14cce7b8cc1657fef016c9c59e5decdc9879f3bf64f23581b5
+  data.tar.gz: 523abe2a99278d2c559931e3b89ba0a946ca03f5e7a3fc92fd0e060555d0a0b25308d863f57904f4f4cc9ddb5fd93535e79bcee9164cff769b3d2ee61a6fcf0c

data/Gemfile.lock

@@ -1,55 +1,58 @@
 PATH
   remote: .
   specs:
-    this_feature (0.5.0)
-    this_feature-adapters-flipper (0.5.0)
+    this_feature (0.6.1)
+    this_feature-adapters-flipper (0.6.1)
       flipper (~> 0.16)
       flipper-active_record (~> 0.16)
       this_feature
-    this_feature-adapters-split_io (0.5.0)
+    this_feature-adapters-split_io (0.6.1)
       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)
+    concurrent-ruby (1.1.8)
     connection_pool (2.2.3)
     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.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    flipper (0.19.0)
-    flipper-active_record (0.19.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.19.0)
-    gem-release (2.1.1)
+      flipper (~> 0.20.3)
+    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)
+    json (2.5.1)
     jwt (2.2.2)
     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 +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,23 +75,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

@@ -63,7 +63,7 @@ These adapters do behave slightly differently, so make sure to read the followin
 
 - [Flipper adapter](./docs/flipper.md)
 - [Split.io adapter](./docs/splitio.md)
-- [Memory adapter](./docs/memory.md) - **very helpful to use in tests**
+- [Memory adapter](./docs/memory.md) - **designed for use in tests**
 
 ## Development
 

data/docs/memory.md

@@ -1,5 +1,24 @@
 # ThisFeature - Memory Adapter
 
+## Synopsis
+
+Under the hood, the memory adapter stores data in a dictionary like so:
+
+```ruby
+{
+  some_flag_name: {
+    global: false,
+    contexts: {
+      User1: true,
+      User2: false
+    }
+  }
+}
+```
+
+Since it doesn't require actual DB lookups, it's faster, and works well for use
+in test suites.
+
 ## Installation
 
 This adapter is included with the core gem:
@@ -16,18 +35,19 @@ require 'this_feature'
 require 'this_feature/adapters/memory'
 
 ThisFeature.configure do |config|
-  adapter = ThisFeature::Adapters::Memory.new
-  config.adapters = [adapter]
-  config.default_adapter = adapter
+  config.test_adapter = ThisFeature::Adapters::Memory.new
+  config.adapters = [config.test_adapter]
+  config.default_adapter = config.test_adapter
 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:
 
-```
-# Say you have this method which you want to use as the "identity" of a context object:
+```ruby
+# Say you have this method which you want to use as the "identity"
+# of a context object (e.g. imagine this module is included onto User)
 module FeatureFlaggable
   def this_feature_id
     "#{self.class}-#{self.id}"
@@ -40,26 +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`.
+### **#on? / #off?**
 
-Read the following notes as well:
+If passed a `context` argument, uses the aformentioned logic
+(`context_key_method`) to determine how it's handled.
 
-- **on?** / **off?**: Under the hood, calls `flipper_id` method on the `context`, if one was given.
+Usage example of these:
 
-- **control?** is not yet implemented
+```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
+```
 
-We also support two additional methods here that aren't present on the main adapter yet:
+### **#clear**
 
-- **on!** / **off!**
+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.
 
-Usage example of these:
-
-```
-# If you have configured the in-memory adapter as the default
-ThisFeature.default_adapter.on!(:flag_name, context: user) # with context
-ThisFeature.default_adapter.off!(:flag_name)               # without context
+```ruby
+ThisFeature.test_adapter.clear
 ```

data/docs/splitio.md

@@ -0,0 +1,35 @@
+# ThisFeature - Split Adapter
+
+## Installation
+
+```ruby
+gem 'this_feature-adapters-split-io
+```
+
+## Configuration
+
+```ruby
+# config/initializers/this_feature.rb
+require 'this_feature'
+require 'this_feature/adapters/split_io'
+
+ThisFeature.configure do |config|
+  adapter = ThisFeature::Adapters::SplitIo.new
+  config.adapters = [adapter]
+  config.default_adapter = adapter
+end
+```
+
+An existing Split client can be optionally passed to the initializer:
+
+```
+ThisFeature::Adapters::SplitIo.new(client: my_existing_client)
+```
+
+## API
+
+The SplitIo adapter supports the public API of `ThisFeature`.
+
+Both `context` and `data` are supported.
+
+`control` is a native Split feature, so we perform a query to Split to get this info.

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,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,11 @@ class ThisFeature
       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: {})

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: this_feature
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Max Pleaner
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2021-03-04 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
@@ -165,8 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Feature flag control
 test_files: []