this_feature 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1ce587cdd7e38a631ec48ebec63a3de11bd96ed5c82abff3b4486a0b09c0f11
-  data.tar.gz: 19643b3951c2483fdf3694073c24cbc71a530997a5192c58ea8a9c835b8c39cf
+  metadata.gz: b6fdd8f4258c9cca45bdf31d7370e100eb9175102ba565f3368f23a83edf8d46
+  data.tar.gz: 79c1cbce63fad4511b3a5828fcc90cecb609db1abf2047c01270f7246c1631be
 SHA512:
-  metadata.gz: 132cb856e2bfb0af4b334bde04a7cce7586a15a3c6a0ffc5a0dde71725cc388deef03b21fc67d1a9f174e950676c832e99b8dbcd7211f187e8864b6918f944c3
-  data.tar.gz: 16a4c927b80d69a40b5104cb9e7d284c0da6423ddac78c89ce6a9b2394cade377f7c981c51f864c9c3fe506e119894081d6215d60f0273592912fbefa5a3892b
+  metadata.gz: b8cb49d96981b3320399c856fcd5367e54fc478c9af60e4bfacbf6d2a54a990fa89db7344e8e1b342cbb2a764e57c7b6ca3f7dddec0247fa6f6521250f40f565
+  data.tar.gz: b3804fb6eb9f37a12e2a8a477ed730ca83ed2cdf7d1a419c39b75ba1d9a4d9243051ee292dfdc59a5d68a2cb3a5d901a2606455916a6a0a22f2b73a5aab27c50

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:
+
+```
+{
+  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,9 +35,9 @@ 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
 ```
 
@@ -26,8 +45,9 @@ The initializer takes an optional `context_key_method` argument. This is only re
 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}"
@@ -48,7 +68,8 @@ The `context` argument is supported, but not `data`.
 
 Read the following notes as well:
 
-- **on?** / **off?**: Under the hood, calls `flipper_id` method on the `context`, if one was given.
+- **on?** / **off?**: If passed a `context` argument, uses the aformentioned logic
+(`context_key_method`) to determine how it's handled.
 
 - **control?** is not yet implemented
 
@@ -60,6 +81,6 @@ 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
+ThisFeature.test_adapter.on!(:flag_name, context: user) # with context
+ThisFeature.test_adapter.off!(:flag_name)               # without context
 ```

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

@@ -1,3 +1,3 @@
 class ThisFeature
-  VERSION = "0.5.0"
+  VERSION = "0.5.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.5.1
 platform: ruby
 authors:
 - Max Pleaner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler