flip_fab 1.0.0 → 1.0.16

data/flip_fab.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'flip_fab/version'
 
@@ -8,13 +7,20 @@ Gem::Specification.new do |spec|
   spec.version       = FlipFab::VERSION
   spec.authors       = ['Simply Business']
   spec.email         = ['tech@simplybusiness.co.uk']
-  spec.description   = %q{A gem providing persistent, per-user feature flipping to Rack applications.}
-  spec.summary       = %q{A gem providing persistent, per-user feature flipping to Rack applications.}
+  spec.description   = 'A gem providing persistent, per-user feature flipping to Rack applications.'
+  spec.summary       = 'A gem providing persistent, per-user feature flipping to Rack applications.'
   spec.homepage      = 'https://github.com/simplybusiness/flip_fab'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rack', '>=2.1.1'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rutabaga', '~> 3.0'
+  spec.add_development_dependency 'simplycop', '~> 1.9'
+  spec.add_development_dependency 'timecop', '~> 0.8'
 end

data/lib/flip_fab/contextual_feature.rb

@@ -2,13 +2,19 @@ module FlipFab
   class ContextualFeature
     attr_reader :feature, :context
 
-    def initialize feature, context
+    def initialize(feature, context)
       @feature = feature
       @context = context
-      if overridden?
-        @state = override
-        persist
-      end
+      return unless overridden?
+
+      @state = override
+      persist
+    end
+
+    def as_json(options = {})
+      {
+        'feature' => feature.as_json(options)
+      }
     end
 
     def enabled?
@@ -27,16 +33,16 @@ module FlipFab
       self.state = :disabled
     end
 
-    def state= value
-      raise "Invalid state provided: `#{value}`, possible states are :enabled, :disabled" unless %i(enabled disabled).include? value
-      unless overridden?
-        @state = value
-        persist
-      end
+    def state=(value)
+      raise "Invalid state provided: `#{value}`, possible states are :enabled, :disabled" unless %i[enabled disabled].include? value
+      return if overridden?
+
+      @state = value
+      persist
     end
 
     def persist
-      persistence_adapters.each{ |adapter| adapter.write state }
+      persistence_adapters.each { |adapter| adapter.write state }
     end
 
     private
@@ -46,11 +52,7 @@ module FlipFab
     end
 
     def state
-      @state ||= if state_in_context?
-        state_from_context
-      else
-        default_state
-      end
+      @state ||= state_in_context? ? state_from_context : default_state
     end
 
     def state_in_context?
@@ -62,7 +64,7 @@ module FlipFab
     end
 
     def first_adapter_with_state
-      persistence_adapters.detect{|adapter| !adapter.read.nil?}
+      persistence_adapters.detect { |adapter| !adapter.read.nil? }
     end
 
     def default_state
@@ -71,8 +73,10 @@ module FlipFab
 
     def override
       return unless context.respond_to? :params
+
       override = context.params[feature.name.to_s]
-      return unless %w(enabled disabled).include? override
+      return unless %w[enabled disabled].include? override
+
       override.to_sym
     end
 

data/lib/flip_fab/cookie_persistence.rb

@@ -1,12 +1,11 @@
 module FlipFab
   class CookiePersistence < FlipFab::Persistence
+    COOKIE_PATH = '/'.freeze
+    COOKIE_DURATION_MONTHS = 12
+    # See: https://github.com/rails/rails/blob/b1124a2ac88778c0feb0157ac09367cbd204bf01/actionpack/lib/action_dispatch/middleware/cookies.rb#L214
+    DOMAIN_REGEXP          = /[^.]*\.([^.]*|..\...|...\...)$/
 
-      COOKIE_PATH            = '/'
-      COOKIE_DURATION_MONTHS = 12
-      # See: https://github.com/rails/rails/blob/b1124a2ac88778c0feb0157ac09367cbd204bf01/actionpack/lib/action_dispatch/middleware/cookies.rb#L214
-      DOMAIN_REGEXP          = /[^.]*\.([^.]*|..\...|...\...)$/
-
-    def initialize feature_name, context
+    def initialize(feature_name, context)
       super
     end
 
@@ -14,14 +13,10 @@ module FlipFab
       value.to_sym unless value.nil?
     end
 
-    def write state
-      cookie_domain = ".#{top_level_domain}" unless top_level_domain.nil?
-      context.response.set_cookie key, {
-        value:   state,
-        expires: cookie_expiration,
-        domain:  cookie_domain,
-        path:    COOKIE_PATH,
-      }
+    def write(state)
+      context.response.set_cookie key, value: state,
+                                       expires: cookie_expiration,
+                                       path: COOKIE_PATH
     end
 
     private
@@ -36,9 +31,7 @@ module FlipFab
 
     # See: https://github.com/rails/rails/blob/b1124a2ac88778c0feb0157ac09367cbd204bf01/actionpack/lib/action_dispatch/middleware/cookies.rb#L286-L294
     def top_level_domain
-      if (host !~ /^[\d.]+$/) && (host =~ DOMAIN_REGEXP)
-        $&
-      end
+      Regexp.last_match(0) if (host !~ /^[\d.]+$/) && (host =~ DOMAIN_REGEXP)
     end
 
     def cookie_expiration

data/lib/flip_fab/feature.rb

@@ -1,9 +1,8 @@
 module FlipFab
   class Feature
-
     attr_reader :name, :default, :persistence_adapters
 
-    def initialize name, options={}
+    def initialize(name, options = {})
       @name                 = name
       @default              = options[:default] || :disabled
       @persistence_adapters = options[:persistence_adapters] || [CookiePersistence]
@@ -17,7 +16,7 @@ module FlipFab
       !enabled?
     end
 
-    def with_context context
+    def with_context(context)
       ContextualFeature.new self, context
     end
   end

data/lib/flip_fab/features_by_name.rb

@@ -4,17 +4,18 @@ module FlipFab
   class FeaturesByName
     extend Forwardable
 
-    def initialize features_by_name={}
+    def initialize(features_by_name = {})
       @features_by_name = features_by_name
     end
 
-    def [] name
+    def [](name)
       raise "no feature has been defined with the name: #{name}" if @features_by_name[name].nil?
+
       @features_by_name[name]
     end
 
-    def with_context context
-      FeaturesByName.new Hash[@features_by_name.map{|name, feature| [name, (feature.with_context context)]}]
+    def with_context(context)
+      FeaturesByName.new Hash[@features_by_name.map { |name, feature| [name, (feature.with_context context)] }]
     end
 
     def_delegators :@features_by_name, :[]=, :clear, :count, :each

data/lib/flip_fab/helper.rb

@@ -1,6 +1,5 @@
 module FlipFab
   module Helper
-
     def features
       @features ||= FlipFab.features.with_context self
     end

data/lib/flip_fab/persistence.rb

@@ -1,9 +1,8 @@
 module FlipFab
   class Persistence
-
     attr_reader :feature_name, :context
 
-    def initialize feature_name, context
+    def initialize(feature_name, context)
       @feature_name = feature_name
       @context      = context
     end
@@ -12,7 +11,7 @@ module FlipFab
       raise NotImplementedError
     end
 
-    def write state
+    def write(state)
       raise NotImplementedError
     end
   end

data/lib/flip_fab/version.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
 module FlipFab
-  VERSION = '1.0.0'
+  base = '1.0.16'
+
+  # SB-specific versioning "algorithm" to accommodate BNW/Jenkins/gemstash
+  VERSION = (pre = ENV.fetch('GEM_PRE_RELEASE', '')).empty? ? base : "#{base}.#{pre}"
 end

data/lib/flip_fab.rb

@@ -6,19 +6,19 @@ require 'flip_fab/persistence'
 require 'flip_fab/cookie_persistence'
 
 module FlipFab
-  extend self
-
   attr_reader :features
 
-  def define_feature name, options={}
+  def define_feature(name, options = {})
     @features ||= {}
     @features[name] = Feature.new name, options
   end
 
   @features ||= FeaturesByName.new
+
+  module_function :features, :define_feature
 end
 
 if defined?(ActionController)
-  ActionController::Base.send :include, FlipFab::Helper
+  ActionController::Base.include FlipFab::Helper
   ActionController::Base.helper FlipFab::Helper
 end

data/script/cibuild

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# script/cibuild: Setup environment for CI to run tests. This is primarily
+#                 designed to run on the continuous integration server.
+
+set -e
+
+cd "$(dirname "$0")/.."
+bundle exec rubocop --fail-level warning
+

data/spec/lib/flip_fab/contextual_feature_spec.rb

@@ -1,15 +1,20 @@
 module FlipFab
-  describe ContextualFeature do
-    let(:override)             {  }
+  describe ContextualFeature do # rubocop:disable Metrics/BlockLength
+    let(:override)             {}
     let(:default)              { :disabled }
     let(:persistence_adapters) { [TestPersistence] }
-    let(:feature)              { Feature.new :example_feature, { default: default, persistence_adapters: persistence_adapters } }
-    let(:feature_states)       {{ example_feature: :enabled }}
-    let(:context)              { TestContext.new feature_states, { 'example_feature' => override } }
-    subject{ described_class.new feature, context }
+    let(:feature)              { Feature.new :example_feature, default: default, persistence_adapters: persistence_adapters }
+    let(:feature_states)       { { example_feature: :enabled } }
+    let(:context)              { TestContext.new feature_states, 'example_feature' => override }
+    subject { described_class.new feature, context }
+
+    describe '.as_json' do
+      it 'returns only the feature' do
+        expect(subject.as_json.keys).to eq(['feature'])
+      end
+    end
 
     describe '.new' do
-
       it 'assigns the feature' do
         expect(subject.feature).to eq(feature)
       end
@@ -22,23 +27,22 @@ module FlipFab
         let(:override) { 'disabled' }
 
         it 'persists the override' do
-          expect{ subject }.to change{ feature_states }.from({ example_feature: :enabled }).to({ example_feature: :disabled })
+          expect { subject }.to change { feature_states }.from(example_feature: :enabled).to(example_feature: :disabled)
         end
 
         context 'when the override provided is not one of enabled or disabled, it does not persist the override' do
           let(:override) { '' }
 
           it 'does not persist the override' do
-            expect{ subject }.not_to change{ feature_states }.from({ example_feature: :enabled })
+            expect { subject }.not_to change { feature_states }.from(example_feature: :enabled)
           end
         end
       end
     end
 
     describe '#enabled?' do
-
       context 'when the feature is enabled in the adapter' do
-        let(:feature_states) {{ example_feature: :enabled }}
+        let(:feature_states) { { example_feature: :enabled } }
 
         it 'returns true' do
           expect(subject.enabled?).to be_truthy
@@ -54,7 +58,7 @@ module FlipFab
       end
 
       context 'when the feature is disabled in the adapter' do
-        let(:feature_states) {{ example_feature: :disabled }}
+        let(:feature_states) { { example_feature: :disabled } }
 
         it 'returns false' do
           expect(subject.enabled?).to be_falsey
@@ -62,7 +66,7 @@ module FlipFab
       end
 
       context 'when the feature is not specified in the adapter' do
-        let(:feature_states) {{ }}
+        let(:feature_states) { {} }
 
         context 'when the default is :enabled' do
           let(:default) { :enabled }
@@ -85,7 +89,7 @@ module FlipFab
         let(:persistence_adapters) { [TestPersistence, TestMultiplePersistence] }
 
         context 'when the first adapter has enabled and the second adapter has nil' do
-          let(:feature_states) {{ example_feature: :enabled, different_example_feature: nil }}
+          let(:feature_states) { { example_feature: :enabled, different_example_feature: nil } }
 
           it 'returns true' do
             expect(subject.enabled?).to be_truthy
@@ -93,7 +97,7 @@ module FlipFab
         end
 
         context 'when the first adapter has nil and the second adapter has enabled' do
-          let(:feature_states) {{ example_feature: nil, different_example_feature: :enabled }}
+          let(:feature_states) { { example_feature: nil, different_example_feature: :enabled } }
 
           it 'returns true' do
             expect(subject.enabled?).to be_truthy
@@ -101,7 +105,7 @@ module FlipFab
         end
 
         context 'when the first adapter has disabled and the second adapter has enabled' do
-          let(:feature_states) {{ example_feature: :disabled, different_example_feature: :enabled }}
+          let(:feature_states) { { example_feature: :disabled, different_example_feature: :enabled } }
 
           it 'returns false' do
             expect(subject.enabled?).to be_falsey
@@ -111,9 +115,8 @@ module FlipFab
     end
 
     describe '#disabled?' do
-
       context 'when #enabled? returns true' do
-        let(:feature_states) {{ example_feature: :enabled }}
+        let(:feature_states) { { example_feature: :enabled } }
 
         it 'returns false' do
           expect(subject.disabled?).to be_falsey
@@ -121,7 +124,7 @@ module FlipFab
       end
 
       context 'when #enabled? returns false' do
-        let(:feature_states) {{ example_feature: :disabled }}
+        let(:feature_states) { { example_feature: :disabled } }
 
         it 'returns true' do
           expect(subject.disabled?).to be_truthy
@@ -130,34 +133,30 @@ module FlipFab
     end
 
     describe '#state=' do
-
       context 'when the provided value is not :enabled or :disabled' do
-
         it 'raises' do
-          expect{ subject.state = '' }.to raise_error 'Invalid state provided: ``, possible states are :enabled, :disabled'
-          expect{ subject.state = 'enabled' }.to raise_error 'Invalid state provided: `enabled`, possible states are :enabled, :disabled'
+          expect { subject.state = '' }.to raise_error 'Invalid state provided: ``, possible states are :enabled, :disabled'
+          expect { subject.state = 'enabled' }.to raise_error 'Invalid state provided: `enabled`, possible states are :enabled, :disabled'
         end
       end
 
       context 'when the provided value is :enabled or :disabled' do
-
         it 'changes the state of the feature' do
-          expect{ subject.state = :disabled }.to change{subject.enabled?}.from(true).to(false)
-          expect{ subject.state = :enabled }.to change{subject.enabled?}.from(false).to(true)
+          expect { subject.state = :disabled }.to change { subject.enabled? }.from(true).to(false)
+          expect { subject.state = :enabled }.to change { subject.enabled? }.from(false).to(true)
         end
       end
     end
 
     describe '#enable' do
-
       context 'when the state has been overridden' do
         let(:override) { 'disabled' }
 
         context 'and the persistence adapter has the opposite state' do
-          let(:feature_states) {{ example_feature: :disabled }}
+          let(:feature_states) { { example_feature: :disabled } }
 
           it 'does not change the state of the feature' do
-            expect{subject.enable}.not_to change{subject.enabled?}.from(false)
+            expect { subject.enable }.not_to change { subject.enabled? }.from(false)
           end
 
           it 'does not persist the state in the adapter' do
@@ -169,14 +168,14 @@ module FlipFab
 
       context 'when there are multiple persistence adapters' do
         let(:persistence_adapters) { [TestPersistence, TestMultiplePersistence] }
-        let(:feature_states) {{ example_feature: :disabled, different_example_feature: :disabled }}
+        let(:feature_states) { { example_feature: :disabled, different_example_feature: :disabled } }
 
         it 'changes the state of the feature' do
-          expect{subject.enable}.to change{subject.enabled?}.from(false).to(true)
+          expect { subject.enable }.to change { subject.enabled? }.from(false).to(true)
         end
 
         it 'persists the state in the adapters' do
-          expect{ subject.enable }.to change{ feature_states }.from({ example_feature: :disabled, different_example_feature: :disabled }).to({ example_feature: :enabled, different_example_feature: :enabled })
+          expect { subject.enable }.to change { feature_states }.from(example_feature: :disabled, different_example_feature: :disabled).to(example_feature: :enabled, different_example_feature: :enabled)
         end
       end
 
@@ -184,37 +183,37 @@ module FlipFab
         let(:persistence_adapters) { [TestPersistence] }
 
         context 'and the persistence adapter has the same state' do
-          let(:feature_states) {{ example_feature: :enabled }}
+          let(:feature_states) { { example_feature: :enabled } }
 
           it 'does not change the state of the feature' do
-            expect{subject.enable}.not_to change{subject.enabled?}.from(true)
+            expect { subject.enable }.not_to change { subject.enabled? }.from(true)
           end
         end
 
         context 'and the persistence adapter has the opposite state' do
-          let(:feature_states) {{ example_feature: :disabled }}
+          let(:feature_states) { { example_feature: :disabled } }
 
           it 'changes the state of the feature' do
-            expect{subject.enable}.to change{subject.enabled?}.from(false).to(true)
+            expect { subject.enable }.to change { subject.enabled? }.from(false).to(true)
           end
 
           it 'persists the state in the adapter' do
-            expect{ subject.enable }.to change{ feature_states }.from({ example_feature: :disabled }).to({ example_feature: :enabled })
+            expect { subject.enable }.to change { feature_states }.from(example_feature: :disabled).to(example_feature: :enabled)
           end
         end
 
         context 'and the persistence adapter has no state' do
-          let(:feature_states) {{ }}
+          let(:feature_states) { {} }
 
           context 'and the feature is disabled' do
             let(:default) { :disabled }
 
             it 'changes the state of the feature' do
-              expect{subject.enable}.to change{subject.enabled?}.from(false).to(true)
+              expect { subject.enable }.to change { subject.enabled? }.from(false).to(true)
             end
 
             it 'persists the state in the adapter' do
-              expect{ subject.enable }.to change{ feature_states }.from({ }).to({ example_feature: :enabled })
+              expect { subject.enable }.to change { feature_states }.from({}).to(example_feature: :enabled)
             end
           end
 
@@ -222,11 +221,11 @@ module FlipFab
             let(:default) { :enabled }
 
             it 'does not change the state of the feature' do
-              expect{subject.enable}.not_to change{subject.enabled?}.from(true)
+              expect { subject.enable }.not_to change { subject.enabled? }.from(true)
             end
 
             it 'persists the state in the adapter' do
-              expect{ subject.enable }.to change{ feature_states }.from({ }).to({ example_feature: :enabled })
+              expect { subject.enable }.to change { feature_states }.from({}).to(example_feature: :enabled)
             end
           end
         end
@@ -238,7 +237,7 @@ module FlipFab
             let(:default) { :enabled }
 
             it 'does not change the state of the feature' do
-              expect{subject.enable}.not_to change{subject.enabled?}.from(true)
+              expect { subject.enable }.not_to change { subject.enabled? }.from(true)
             end
           end
 
@@ -246,24 +245,22 @@ module FlipFab
             let(:default) { :disabled }
 
             it 'changes the state of the feature' do
-              expect{subject.enable}.to change{subject.enabled?}.from(false).to(true)
+              expect { subject.enable }.to change { subject.enabled? }.from(false).to(true)
             end
           end
         end
       end
     end
 
-
     describe '#disable' do
-
       context 'when the state has been overridden' do
         let(:override) { 'enabled' }
 
         context 'and the persistence adapter has the opposite state' do
-          let(:feature_states) {{ example_feature: :enabled }}
+          let(:feature_states) { { example_feature: :enabled } }
 
           it 'does not change the state of the feature' do
-            expect{subject.disable}.not_to change{subject.disabled?}.from(false)
+            expect { subject.disable }.not_to change { subject.disabled? }.from(false)
           end
 
           it 'does not persist the state in the adapter' do
@@ -277,18 +274,18 @@ module FlipFab
         let(:persistence_adapters) { [TestPersistence] }
 
         context 'and the persistence adapter has the same state' do
-          let(:feature_states) {{ example_feature: :disabled }}
+          let(:feature_states) { { example_feature: :disabled } }
 
           it 'does not change the state of the feature' do
-            expect{subject.disable}.not_to change{subject.disabled?}.from(true)
+            expect { subject.disable }.not_to change { subject.disabled? }.from(true)
           end
         end
 
         context 'and the persistence adapter has the opposite state' do
-          let(:feature_states) {{ example_feature: :enabled }}
+          let(:feature_states) { { example_feature: :enabled } }
 
           it 'changes the state of the feature' do
-            expect{subject.disable}.to change{subject.disabled?}.from(false).to(true)
+            expect { subject.disable }.to change { subject.disabled? }.from(false).to(true)
           end
 
           it 'persists the state in the adapter' do
@@ -298,13 +295,13 @@ module FlipFab
         end
 
         context 'and the persistence adapter has no state' do
-          let(:feature_states) {{ }}
+          let(:feature_states) { {} }
 
           context 'and the feature is enabled' do
             let(:default) { :enabled }
 
             it 'changes the state of the feature' do
-              expect{subject.disable}.to change{subject.disabled?}.from(false).to(true)
+              expect { subject.disable }.to change { subject.disabled? }.from(false).to(true)
             end
 
             it 'persists the state in the adapter' do
@@ -317,7 +314,7 @@ module FlipFab
             let(:default) { :disabled }
 
             it 'does not change the state of the feature' do
-              expect{subject.disable}.not_to change{subject.disabled?}.from(true)
+              expect { subject.disable }.not_to change { subject.disabled? }.from(true)
             end
 
             it 'persists the state in the adapter' do
@@ -334,7 +331,7 @@ module FlipFab
             let(:default) { :disabled }
 
             it 'does not change the state of the feature' do
-              expect{subject.disable}.not_to change{subject.disabled?}.from(true)
+              expect { subject.disable }.not_to change { subject.disabled? }.from(true)
             end
           end
 
@@ -342,7 +339,7 @@ module FlipFab
             let(:default) { :enabled }
 
             it 'changes the state of the feature' do
-              expect{subject.disable}.to change{subject.disabled?}.from(false).to(true)
+              expect { subject.disable }.to change { subject.disabled? }.from(false).to(true)
             end
           end
         end

data/spec/lib/flip_fab/cookie_persistence.feature

@@ -10,10 +10,10 @@ Feature: Persisting the feature state in a cookie
     When I persist the feature state in a cookie
     Then the cookie has the path '/'
 
-  Scenario Outline: The cookie should apply for all domains under the top-level domain (no domain for localhost or IP addresses, however)
+  Scenario Outline: The cookie populated should not contain domain
     Given the host is '<host>'
      When I persist the feature state in a cookie
-     Then the cookie has the domain '<cookie domain>'
+     Then the cookie does not have domain '<cookie domain>'
 
     Examples:
       | host                           | cookie domain         |
@@ -37,7 +37,7 @@ Feature: Persisting the feature state in a cookie
 
   Scenario: The cookie should expire after 1 year
     When I persist the feature state in a cookie
-    Then the cookie expires at 'Fri, 22 Jan 2016 15:26:31 -0000'
+    Then the cookie expires at 'Fri, 22 Jan 2016 15:26:31 GMT'
 
   Scenario Outline: The cookie's value should be the state of the feature
    Given the state of the feature is '<feature state>'