offs 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7f44fb139c3f2a88d2510ee22559e18037d9a32
-  data.tar.gz: 0b224e3575e8f241ffec5e5f2a370b2d402ba565
+  metadata.gz: cc1b08f770214df36eb4c408459b0060fc9dd8af
+  data.tar.gz: 43f9ab69b33a234eae79f53555c52772933628ed
 SHA512:
-  metadata.gz: fcea828f9ec2c1819e231f8964083575d8f1d83277ee3371826d62c1b4057d6487e6a5f6da178b9c3621dd7c0616d04539ab2c8534d22205ef042238559b9ee0
-  data.tar.gz: 19b9c2ccbb99a95b397421a2c17731408cf73a6502098d7bb3ab1a2acf6412d8c22200b609759e0b1f11db1744107ddff8be2c583fa69ed964c4fcb7f9a837cc
+  metadata.gz: eb477f36c3cac9362b242d04ca9b66019a4d888131f1543ce9168d35f61fde7d683122dbefcddab14ef3ed18ea949a6aa6d7069733b1b1980eb91ffdef3e7b01
+  data.tar.gz: 4ffce2d90133a5072a75bb2085e68faf20a8a366ae1da7a82a87565cc371db79b7e2dc3e1655644430a4740ae235e6abc64fe99299b0a49d17e332a0a812efd2

data/README.md

@@ -38,8 +38,10 @@ you could put the following in `config/initializers/offs_flags.rb`:
 ```ruby
 require 'offs'
 
-OFFS.flag :use_my_million_dollar_idea, false
-OFFS.flag :use_this_mostly_done_feature, true
+OFFS::Flags.set do |offs|
+  offs.flag :use_my_million_dollar_idea, false
+  offs.flag :use_this_mostly_done_feature, true
+end
 ```
 
 You've now defined the flags that your app will use, and you've given

data/lib/offs/flags.rb

@@ -0,0 +1,45 @@
+class OFFS
+  class Flags
+    UndefinedFlagError = Class.new(StandardError)
+
+    class << self
+      def instance
+        @instance ||= new
+      end
+
+      def set(&block)
+        block.call(instance)
+        instance
+      end
+    end
+
+    def flag(name, default)
+      env_var_name = name.to_s.upcase
+      feature_flags[name] = if ENV.has_key?(env_var_name)
+                              ENV[env_var_name].strip == '1'
+                            else
+                              default
+                            end
+    end
+
+    def feature_flags
+      @feature_flags ||= {}
+    end
+
+    def enabled?(flag)
+      !!feature_flags[flag]
+    end
+
+    def valid?(flag)
+      feature_flags.has_key?(flag)
+    end
+
+    def validate!(flag)
+      if valid?(flag)
+        flag
+      else
+        raise UndefinedFlagError, "The #{flag} flag has not been defined."
+      end
+    end
+  end
+end

data/lib/offs/permutations.rb

@@ -0,0 +1,28 @@
+require 'delegate'
+require 'injectable_dependencies'
+
+class OFFS
+  class Permutations < DelegateClass(Enumerator)
+    include InjectableDependencies
+
+    dependency(:flags) { Flags.instance }
+
+    def initialize(options={})
+      initialize_dependencies(options[:dependencies])
+      __setobj__ create_permutations
+    end
+
+    private
+
+    def create_permutations
+      keys = flags.to_a
+      permutations = [true,false].repeated_permutation(keys.size).map { |values|
+        keys.zip(values).inject({}) { |m, pair|
+          m[pair[0]] = pair[1]
+          m
+        }
+      }
+      permutations.each
+    end
+  end
+end

data/lib/offs/version.rb

@@ -1,3 +1,3 @@
 class OFFS
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/offs.rb

@@ -1,31 +1,17 @@
 require "offs/version"
+require 'offs/flags'
 require 'injectable_dependencies'
 
 class OFFS
   include InjectableDependencies
 
-  UndefinedFlagError = Class.new(StandardError)
-
   class << self
     def so_you_want_to(flag, &block)
       new(flag).so_you_want_to(&block)
     end
-
-    def flag(name, default)
-      env_var_name = name.to_s.upcase
-      feature_flags[name] = if ENV.has_key?(env_var_name)
-                              ENV[env_var_name].strip == '1'
-                            else
-                              default
-                            end
-    end
-
-    def feature_flags
-      @feature_flags ||= {}
-    end
   end
 
-  dependency(:feature_flags) { OFFS.feature_flags }
+  dependency(:feature_flags) { Flags.instance }
 
   def initialize(flag, options={})
     initialize_dependencies options[:dependencies]
@@ -37,28 +23,26 @@ class OFFS
   end
 
   def would_like_to(&block)
-    return unless flag_is_on?
-    block.call
+    when_flag(true, &block)
   end
 
   def may_still_need_to(&block)
-    return if flag_is_on?
-    block.call
+    when_flag(false, &block)
   end
 
   private
 
   attr_reader :flag
 
-  def flag_is_on?
-    !!feature_flags[flag]
+  def when_flag(bool, &block)
+    block.call if flag_status == bool
+  end
+
+  def flag_status
+    feature_flags.enabled?(flag)
   end
 
   def flag=(new_flag)
-    if feature_flags.has_key?(new_flag)
-      @flag = new_flag
-    else
-      raise UndefinedFlagError, "The #{new_flag} flag has not been defined."
-    end
+    @flag = feature_flags.validate!(new_flag)
   end
 end

data/spec/offs/permutations_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'offs/permutations'
+
+describe OFFS::Permutations do
+  subject { described_class.new(dependencies: dependencies) }
+
+  let(:dependencies) {{
+    flags: flags
+  }}
+
+  let(:flags) { double(:flags, to_a: [:feature_a, :feature_b, :feature_c]) }
+
+  let(:possible_permutations) {[
+    { feature_a: true,  feature_b: true,  feature_c: true  },
+    { feature_a: false, feature_b: true,  feature_c: true  },
+    { feature_a: true,  feature_b: false, feature_c: true  },
+    { feature_a: true,  feature_b: true,  feature_c: false },
+    { feature_a: false, feature_b: false, feature_c: true  },
+    { feature_a: false, feature_b: true,  feature_c: false },
+    { feature_a: true,  feature_b: false, feature_c: false },
+    { feature_a: false, feature_b: false, feature_c: false },
+  ]}
+
+  let(:receiver) { double(:receiver) }
+
+  it 'yields every permutation of feature flag combinations' do
+    possible_permutations.each do |permutation|
+      expect(receiver).to receive(:flags).with(permutation)
+    end
+
+    subject.each do |flags|
+      receiver.flags(flags)
+    end
+  end
+end

data/spec/offs_spec.rb

@@ -13,18 +13,18 @@ describe OFFS do
     feature_flags: feature_flags
   }}
 
-  let(:feature_flags) {{
-    :my_cool_new_feature => feature_status
-  }}
-
-  let(:feature_status) { true }
+  let(:feature_flags) {
+    OFFS::Flags.set do |f|
+      f.flag :my_cool_new_feature, feature_status
+    end
+  }
 
   context 'when the specified feature flag is not defined' do
-    let(:feature_flags) {{}}
+    let(:feature_flags) { OFFS::Flags.new }
 
     it 'raises an error' do
       expect{ subject.so_you_want_to {} }.to \
-        raise_error(OFFS::UndefinedFlagError,
+        raise_error(OFFS::Flags::UndefinedFlagError,
                     "The #{flag} flag has not been defined.")
     end
   end
@@ -41,6 +41,8 @@ describe OFFS do
     end
 
     context "and the feature is turned on by default" do
+      let(:feature_status) { true }
+
       it 'executes the would_like_to block' do
         expect(would_like_to_blk).to receive(:call)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: offs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - John Wilger
@@ -85,8 +85,11 @@ files:
 - README.md
 - Rakefile
 - lib/offs.rb
+- lib/offs/flags.rb
+- lib/offs/permutations.rb
 - lib/offs/version.rb
 - offs.gemspec
+- spec/offs/permutations_spec.rb
 - spec/offs_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -114,5 +117,6 @@ signing_key:
 specification_version: 4
 summary: OFFS Feature Flagging System
 test_files:
+- spec/offs/permutations_spec.rb
 - spec/offs_spec.rb
 - spec/spec_helper.rb