this_feature 0.4.1 → 0.6.0

data/docs/flipper.md

@@ -0,0 +1,41 @@
+# ThisFeature - Flipper Adapter
+
+## Installation
+
+```ruby
+gem 'this_feature-adapters-flipper
+```
+
+## Configuration
+
+```ruby
+# config/initializers/this_feature.rb
+require 'this_feature'
+require 'this_feature/adapters/flipper'
+
+ThisFeature.configure do |config|
+  adapter = ThisFeature::Adapters::Flipper.new
+  config.adapters = [adapter]
+  config.default_adapter = adapter
+end
+```
+
+An existing Flipper client can be optionally passed to the initializer:
+
+```
+ThisFeature::Adapters::Flipper.new(client: my_existing_client)
+```
+
+
+## API
+
+The Flipper adapter supports the public API of `ThisFeature`.
+
+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.
+- **control?** / **present?**: Flipper doesn't have a concept of "control", so we just implement it as `!present?`
+
+It is possible to support `on!` and `off!` from Flipper but that's not implemented yet.

data/docs/memory.md

@@ -0,0 +1,88 @@
+# ThisFeature - Memory Adapter
+
+## Synopsis
+
+Under the hood, the memory adapter stores data in a dictionary like so:
+
+```json
+{
+  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:
+
+```ruby
+gem 'this_feature
+```
+
+## Configuration
+
+```ruby
+# config/initializers/this_feature.rb
+require 'this_feature'
+require 'this_feature/adapters/memory'
+
+ThisFeature.configure do |config|
+  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` - 
+it specifies a method name which should be called on the context object to determine its identity.
+For example:
+
+```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}"
+  end
+end
+
+# Then you would refer to it like so in the initializer:
+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?**: 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
+```

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

@@ -0,0 +1,9 @@
+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.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

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

@@ -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.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: this_feature
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Max Pleaner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,6 +127,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/flipper.html
+- docs/flipper.md
+- docs/memory.md
+- docs/splitio.md
+- docs/writing_an_adapter.md
 - lib/this_feature.rb
 - lib/this_feature/adapters.rb
 - lib/this_feature/adapters/base.rb