flip-flop 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 402aff4b7c0a288f0f8f6bf862faa253a991cdeb
-  data.tar.gz: 6344ef9e5da7ed8cfd854feaf488285f01f3bdef
+  metadata.gz: acc3152ed4ebd7b39e858887a7c13c5db472bec2
+  data.tar.gz: 5f57534081e131d55c7602534cbfeacacc04b261
 SHA512:
-  metadata.gz: eb0ee52c53566d20e347126e2978c10606a0d04f460c426456fbe08d0bf115eeb9c261826148a3fd3668f66e23471a642dc68428da0a6e1b2207d6829adbd13e
-  data.tar.gz: ecaf65cefa2a7d68e85093e1ea3d1593ce2d09ba301dcf3ccdec4eaff90f93adbb865d7d90ceed942d633085e915ac8aba6276c3de3e4a53d2a148bd1e0b66cb
+  metadata.gz: 8fc793de8e5a677db5c9e0bb0b73931ec212753959b6b6c126926cf78a0741b50a797bfe833b41e4bdcd7edbc09a925021fa8811fe4069c1f59923e38cb77b1d
+  data.tar.gz: 16a9c9d267af5fd68348bc2109b5f498279c159860a0d519b6ccde14e0e5156188f7d2ec7e2b7a4cec14de349260998ddce572e7e6d83e3d29afb53e7e38bf31

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flip-flop (0.0.3)
+    flip-flop (0.0.5)
 
 GEM
   remote: https://rubygems.org/
@@ -55,4 +55,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   1.12.4
+   1.12.5

data/README.md

@@ -62,9 +62,12 @@ for example:
   :value: :production
 :another_rails_env_example:
   :type: :rails_env
-  :env:
+  :value:
     - :production
     - :test
+:group_example:
+  :type: :group
+  :value: :group_name
 ```
 
 Example Usage
@@ -118,6 +121,34 @@ Gates
 * `time_range` — enable a feature for the duration of a time range
 * `percentage_of_time` — enable a feature for a given percentage of checks
 * `rails_env` — enable a feature for a specified Rails environment
+* `group` — enable a feature for a specified group of users (needs additional configuration)
+
+Groups
+------
+
+To use the group adapter you need to register a group. For Ruby on Rails this can be done in an initializer.
+Groups are reusable, many features can be tied to a single group.
+
+```ruby
+FlipFlop::Group.register(:administrators) do |user|
+  user.is_admin?
+end
+```
+
+Setup your feature definition. Here is an example using the YAML adapter:
+
+```yaml
+---
+:awesome_admin_only_feature
+  :type: :group
+  :value: :administrators
+```
+
+When checking if the feature is enabled for that group you can provide the actor (user).
+
+```ruby
+FlipFlop.feature_enabled? :awesome_admin_only_feature, user
+```
 
 Adapters
 --------

data/lib/flip-flop.rb

@@ -1,6 +1,7 @@
 require 'flip-flop/gates'
 require 'flip-flop/adapters/memory'
 require 'flip-flop/railtie' if defined? Rails
+require 'flip-flop/group'
 
 module FlipFlop
 
@@ -32,8 +33,8 @@ module FlipFlop
   #
   # Arguments:
   #   feature_name (String/Symbol)
-  def self.feature_enabled?(feature_name)
-    get_instance.feature_enabled? feature_name.to_sym
+  def self.feature_enabled?(feature_name, actor=nil)
+    get_instance.feature_enabled? feature_name.to_sym, actor
   end
   
   class FlipFlop
@@ -63,8 +64,8 @@ module FlipFlop
     #
     # Returns:
     #   boolean
-    def feature_enabled?(feature_name)
-      public_send feature_type(feature_name), feature_value(feature_name)
+    def feature_enabled?(feature_name, actor=nil)
+      public_send feature_type(feature_name), feature_value(feature_name), actor
     rescue
       false
     end

data/lib/flip-flop/adapters/active_record.rb

@@ -6,9 +6,9 @@ module FlipFlop
 
       # override this method to prevent the feature being loaded from the
       # database twice.
-      def feature_enabled?(feature_name)
+      def feature_enabled?(feature_name, actor=nil)
         f = get_feature(feature_name)
-        public_send f.gate_type, f.value
+        public_send f.gate_type, f.value, actor
       rescue
         false
       end
@@ -54,7 +54,7 @@ module FlipFlop
         def gate_type
           super.to_sym
         end
-        
+
       end
     end
   end

data/lib/flip-flop/gates.rb

@@ -2,40 +2,44 @@ require 'date'
 
 module FlipFlop
   module Gates
-    def boolean(value)
+    def boolean(value, actor)
       value
     end
 
-    def date_range(value)
+    def date_range(value, actor)
       value.begin < Date.today && value.end > Date.today
     end
 
-    def until_date(value)
+    def until_date(value, actor)
       Date.today < value
     end
 
-    def after_date(value)
+    def after_date(value, actor)
       Date.today > value
     end
 
-    def time_range(value)
+    def time_range(value, actor)
       value.begin < Time.now.utc && value.end > Time.now.utc
     end
 
-    def until_time(value)
+    def until_time(value, actor)
       Time.now.utc < value
     end
 
-    def after_time(value)
+    def after_time(value, actor)
       Time.now.utc > value
     end
 
-    def percentage_of_time(value)
+    def percentage_of_time(value, actor)
       rand < (value / 100.0)
     end
 
-    def rails_env(value)
+    def rails_env(value, actor)
       value == Rails.env.to_sym || value.include?(Rails.env.to_sym)
     end
+
+    def group(group_name, actor)
+      Group.evaluate_group(group_name, actor)
+    end
   end
 end

data/lib/flip-flop/group.rb

@@ -0,0 +1,19 @@
+module FlipFlop
+
+  class Group
+
+    @@groups = {}
+
+    def self.register group_name, &block
+      @@groups[group_name] = block
+    end
+
+    def self.evaluate_group group_name, actor
+      @@groups[group_name].call actor
+    rescue
+      false
+    end
+
+  end
+
+end

data/lib/flip-flop/version.rb

@@ -1,3 +1,3 @@
 module FlipFlop
-  VERSION = '0.0.3'
-end
+  VERSION = '0.0.5'
+end

data/lib/flip-flop/view_helpers.rb

@@ -11,8 +11,8 @@ module FlipFlop
     #
     # Returns:
     #   boolean
-    def feature_enabled?(feature_name)
-      ::FlipFlop::feature_enabled? feature_name
+    def feature_enabled?(feature_name, actor=nil)
+      ::FlipFlop::feature_enabled? feature_name, actor
     end
   end
 end

data/spec/lib/adapters/yaml_spec.rb

@@ -12,8 +12,20 @@ describe FlipFlop do
     end
 
     it 'should load from yaml file' do
-      expect(FlipFlop::feature_enabled? :on).to be_truthy
-      expect(FlipFlop::feature_enabled? :off).to be_falsey
+      expect(FlipFlop.feature_enabled? :on).to be_truthy
+      expect(FlipFlop.feature_enabled? :off).to be_falsey
+    end
+
+    it 'should still work for group gate' do
+      user1 = { group: "a" }
+      user2 = { group: "b" }
+
+      FlipFlop::Group.register(:group_name) do |actor|
+        actor[:group] == 'a'
+      end
+
+      expect(FlipFlop.feature_enabled? :group_example, user1).to be_truthy
+      expect(FlipFlop.feature_enabled? :group_example, user2).to be_falsey
     end
 
   end

data/spec/lib/view_helpers_spec.rb

@@ -150,4 +150,28 @@ describe DummyController do
     end
   end
 
+  context 'group gate' do
+    before :each do
+      ::FlipFlop::Group.register(:group_a) { |actor| actor[:user_group] == 'asdf' }
+    end
+
+    it 'should be able to execute logic specified when registering a group' do
+      ::FlipFlop::get_instance.set_feature(:awesomeness, :group, :group_a)
+      actor = { user_group: 'asdf' }
+      expect(subject.feature_enabled? :awesomeness, actor).to be_truthy
+    end
+
+    it 'should fail the feature check if the block doesnt pass' do
+      ::FlipFlop::get_instance.set_feature(:awesomeness, :group, :group_a)
+      actor = { user_group: 'qwert' }
+      expect(subject.feature_enabled? :awesomeness, actor).to be_falsey
+    end
+
+    it 'should fail if the group has not been defined' do
+      ::FlipFlop::get_instance.set_feature(:awesomeness, :group, :group_b)
+      actor = { user_group: 'not_there' }
+      expect(subject.feature_enabled? :awesomeness, actor).to be_falsey
+    end
+  end
+
 end

data/spec/test-config.yml

@@ -4,4 +4,7 @@
   :value: true
 :off:
   :type: :boolean
-  :value: false
+  :value: false
+:group_example:
+  :type: :group
+  :value: :group_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flip-flop
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Brian Kulyk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies: []
 description: Enable or disable features easily
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -27,6 +28,7 @@ files:
 - lib/flip-flop/adapters/memory.rb
 - lib/flip-flop/adapters/yaml.rb
 - lib/flip-flop/gates.rb
+- lib/flip-flop/group.rb
 - lib/flip-flop/railtie.rb
 - lib/flip-flop/version.rb
 - lib/flip-flop/view_helpers.rb
@@ -57,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Feature flipper