determinator 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ccc82084d2734ddf50ebb5900f73b9e985bd05f
-  data.tar.gz: 1b231a0fc9228692f357a2db213a170c046fb92e
+  metadata.gz: 17f714ab0a57974a7934bdcf86631e65e4e5111d
+  data.tar.gz: 82caf2b07f4a891cc2621fc1ef72aa8c569347b1
 SHA512:
-  metadata.gz: 968a15520388364e962099c8d762431c38a7ff21825263352f506ace9ee568f03564e2aa5428d9ede53c46a33a2d7c3e482da4339d9503ecaf890b7cdf18a850
-  data.tar.gz: fbe0fface76305e3348c76647f34272df03a0fde293db796d565db8fe3e615c7ebcfd743288d783e7c2892c3847afed85e849b35ca987cb10ada1d24121174d4
+  metadata.gz: 37b01ffc666efd680e085365b61b4516cf3c5300e7b215e98e0dde2e1472ea494f7fc5748f811420f137452ee163ed86488f47360205631cc825e2c896780948
+  data.tar.gz: d974d0c38bf2f3963dfa4661252e9bd41b5ef5d5d11ee3e91a2a85658254ca96d90ec5ae8c1d7b5e332065e7254bd0ff79db4cdb7a091a04a76b2e8094f7fd4a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.12.1 (2018-02-01)
+
+Bug Fix:
+- Allow `.for_actor` calls when using `RSpec::Determinator` to test code that uses determinator. (#44)
+
 # v0.12.0 (2018-01-23)
 
 Feature:

data/README.md

@@ -16,24 +16,38 @@ A gem that works with _Florence_ to deterministically calculate whether an **act
 
 For Deliveroo Employees:
 
-- Many people contribute to Determinator and Florence. We hang out in [this Slack channel](slack://channel?team=T03EUNC3F&id=C7437816J)
+- Many people contribute to Determinator and Florence. We hang out in [this Slack channel](https://deliveroo.slack.com/app_redirect?channel=florence_wg)
 - [This JIRA board](https://deliveroo.atlassian.net/secure/RapidBoard.jspa?rapidView=156) covers pieces of work that are planned or in-flight
 - [This Workplace group](https://deliveroo.facebook.com/groups/1893254264328414/) holds more general discussions about the Florence ecosystem
 
 At the moment we can only promise support for Determinator within Deliveroo, but if you add [issues to this github repo](https://github.com/deliveroo/determinator/issues) we'll try and help if we can!
 
-## Usage
+## Basic Use
 
-Once [set up](#installation), determinator can be used to determine whether a **feature flag** or **experiment** is on or off for the current user and, for experiments, which **variant** they should see.
+Once [set up](#installation), determinator can be used to determine whether a **feature flag** or **experiment** is on or off for the current actor (or user) and, for experiments, which **variant** they should see.
 
 ```ruby
-# Feature flags
+# Feature flags: the basics
+Determinator.instance.feature_flag_on?(:my_feature_name, id: 'some user')
+# => true
+Determinator.instance.feature_flag_on?(:my_feature_name, id: 'another user')
+# => false
+
+# A handy short cut…
+def determinator
+  # See the urther Usage section below for a handy shorthand which means ID
+  # and GUID don't need to be specified every time you need a determination.
+end
+
+# Which means you can also do:
 if determinator.feature_flag_on?(:my_feature_name)
   # Show the feature
 end
 
 # Experiments
 case determinator.which_variant(:my_experiment_name)
+when false
+  # This actor isn't in a target group for this experiment
 when 'control'
   # Do nothing different
 when 'sloths'
@@ -43,7 +57,9 @@ when 'velociraptors'
 end
 ```
 
-Feature flags and experiments can be targeted to specific actors by specifying actor properties (which must match the constraints defined in the feature).
+Please note that Determinator requires an identifier for your actor — either an ID (when they are logged in, eg. a user id), or a globally unique id (GUID) that identifies them across sessions (which would normally be storied in a cookie or in a long-lived session store).
+
+Feature flags and experiments can be limited to actors with specific properties by specifying them when (which must match the constraints defined in the feature).
 
 ```ruby
 # Targeting specific actors
@@ -59,13 +75,9 @@ Writing tests? Check out the [Local development](docs/local_development.md) docs
 
 ## Installation
 
-Determinator requires your application to be subscribed to the a `features` topic via Routemaster.
-
-The drain must expire the routemaster cache on receipt of events, `Routemaster::Drain::CacheBusting.new` or better.
-
-Check the example Rails app in `examples` for more information on how to make use of this gem.
+Determinator requires a initialiser block somewhere in your application's boot process, it might look something like this:
 
-```
+```ruby
 # config/initializers/determinator.rb
 
 require 'determinator/retrieve/routemaster'
@@ -79,38 +91,90 @@ Determinator.configure(
 )
 ```
 
-### Using Determinator in RSpec
+This configures the `Determinator.instance` with:
+
+- What **retrieval** mechanism should be used to get feature details
+- (optional) How **errors** should be reported
+- (optional) How **missing features** should be monitored (as they indicate something's up with your code or your set up!)
 
-* Include those lines in `spec_helper.rb`.
+You may also want to configure a `determinator` helper method inside your web request scope, see below for more information.
 
+## Further Usage
 
+Once this is done you can ask for a determination like this:
+
+```ruby
+# Anywhere in your application:
+variant = Determinator.instance.which_variant?(
+  :my_experiment_name,
+  id: 123,
+  guid: 'anonymous id',
+  properties: {
+    employee: true,
+    using_top_level_domain: 'uk'
+  }
+)
 ```
-require 'rspec/determinator'
 
-Determinator.configure(retrieval: nil)
+Or, if you're within a web request, you might want to use a shorthand, and let determinator remember the ID, GUID and any properties which will be true. The following will have the same effect:
 
+```ruby
+# Somewhere inside your request's scope:
+def determinator
+  @determinator ||= Determinator.instance.for_actor(
+    id: 123,
+    guid: 'anonymous id',
+    default_properties: {
+      employee: true,
+      using_top_level_domain: 'uk'
+    }
+  )
+end
+
+# Anywhere in your requests' scope:
+determinator.which_variant(:my_experiment_name)
 ```
 
-* Tag your rspec test with `:determinator_support`, so `forced_determination` helper method will be available.
+Check the example Rails app in the `examples` directory for more information on how to make use of this gem.
+
+### Routemaster
+
+Determinator's [Routemaster](https://github.com/deliveroo/routemaster) integration requires your application to be subscribed to the a `features` topic.
+
+The drain must expire the routemaster cache on receipt of events, making use of  `Routemaster::Drain::CacheBusting.new` or similar is recommended.
+
+### Using Determinator in RSpec
+
+* Include the  `spec_helper.rb`.
 
+```ruby
+require 'rspec/determinator'
 
+Determinator.configure(retrieval: nil)
 ```
 
+* Tag your rspec test with `:determinator_support`, so the `forced_determination` helper method will be available.
+
+```ruby
 RSpec.describe "something", :determinator_support do
 
   context "something" do
     forced_determination(:my_feature_flag, true)
     forced_determination(:my_experiment, "variant_a")
+    forced_determination(:my_lazyexperiment, :some_lazy_variable)
+    let(:some_lazy_variable) { 'variant_b' }
 
     it "uses forced_determination" do
       expect(Determinator.instance.feature_flag_on?(:my_feature_flag)).to eq(true)
       expect(Determinator.instance.which_variant(:my_experiment)).to eq("variant_a")
+      expect(Determinator.instance.which_variant(:my_lazy_experiment)).to eq("variant_b")
     end
   end
 end
-
 ```
 
+* Check out [the specs for `RSpec::Determinator`](spec/rspec/determinator_spec.rb) to find out what you can do!
+
 ### Retrieval Cache
 
 Determinator will function fully without a retrieval_cache set, although Determinator will produce 1 Redis query for every determination. By setting a `retrieval_cache` as an instance of `ActiveSupport::Cache::MemoryStore` (or equivalent) this can be reduced per application instance. This cache is not expired so *must* have a `expires_in` set, ideally to a short amount of time.

data/lib/determinator/version.rb

@@ -1,3 +1,3 @@
 module Determinator
-  VERSION = '0.12.0'
+  VERSION = '0.12.1'
 end

data/lib/rspec/determinator.rb

@@ -40,6 +40,10 @@ module RSpec
         @mocked_results = Hash.new { |h, k| h[k] = {} }
       end
 
+      def for_actor(**args)
+        ::Determinator::ActorControl.new(self, **args)
+      end
+
       def mock_result(name, result, only_for: {})
         @mocked_results[name.to_s][only_for] = result
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: determinator
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - JP Hastings-Spital
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: routemaster-drain