offs 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13568710d593b1098f5e5de00b8ed58f69a73b31
-  data.tar.gz: ff7e020f519770ee2733e6d85e00519cb78bb456
+  metadata.gz: c7db6d39408404296ef58f569ece95b32633ef09
+  data.tar.gz: 2eaa89d57e80b8c512819fcf96fe6bb562bb9ba6
 SHA512:
-  metadata.gz: 68f264e63bafbd12fb4ff68438b00bcb6d7ef288e8c746c66073fe8dfdf48f775a829905749d6b56d0352a0c0e68c56186cc2e38ac20fe6813371c5adae174b0
-  data.tar.gz: bae87536ff2b96f8dc16a38bdeae5f52ecc3aa191acda5db1eb462d82bdf070a757d735ba6b1edf8cd8924a6c0972c34c951f98b28b4e793a9db40bc9c853e56
+  metadata.gz: d3996fa7d6619ba57aa666114d805a66f29c17fa4285c5223dcbe610d1c210d6d6c15192fd6382c67006caabe843525008ef9d0395dd4408acbabc89b7fc4557
+  data.tar.gz: 2f44320aed399e0a488f397e2ec8738e36fc627fff2e33536870c08efcc44cec361d8dcb9e856c53082339deb7afef48c38c7a6b90a05ce75ee5ca9070c09e2c

data/README.md

@@ -76,12 +76,20 @@ class Foo
       end
     end
   end
+
+  def do_something_for_new_feature
+    OFFS.raise_error_unless_we :use_my_million_dollar_idea
+    # The following code will only be reached if the feature is enabled.
+    # Otherwise we raise an OFFS::FeatureDisabled error
+  end
 end
 ```
 
 Note that you are not required to have *both* the `would_like_to` and
 `may_still_need_to` blocks present; they simply become a noop if not
-present.
+present. Shortcuts for this usage are provided via
+`OFFS.if_you_would_like_to` and `OFFS.if_you_do_not_want_to`,
+respectively.
 
 ## Contributing
 

data/lib/offs/version.rb

@@ -1,3 +1,3 @@
 class OFFS
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/offs.rb

@@ -5,6 +5,8 @@ require 'injectable_dependencies'
 class OFFS
   include InjectableDependencies
 
+  class FeatureDisabled < RuntimeError; end
+
   class << self
     def so_you_want_to(flag, &block)
       new(flag).so_you_want_to(&block)
@@ -22,6 +24,10 @@ class OFFS
       end
     end
 
+    def raise_error_unless_we(flag)
+      new(flag).raise_error_unless_we
+    end
+
     def feature_flags
       Flags.instance.to_a
     end
@@ -47,6 +53,14 @@ class OFFS
     when_flag(false, &block)
   end
 
+  def raise_error_unless_we
+    unless flag_enabled?
+      raise FeatureDisabled,
+        "Attempted to access code that is only available when the '#{flag}' " \
+        + "feature is enabled, and it is currenlty disabled."
+    end
+  end
+
   private
 
   attr_reader :flag
@@ -59,6 +73,7 @@ class OFFS
   def flag_status
     feature_flags.enabled?(flag)
   end
+  alias_method :flag_enabled?, :flag_status
 
   def flag=(new_flag)
     @flag = feature_flags.validate!(new_flag)

data/spec/offs_spec.rb

@@ -80,6 +80,10 @@ describe OFFS do
         end
         expect(x).to be_nil
       end
+
+      it 'noops for raise_error_unless_we' do
+        OFFS.raise_error_unless_we(:my_cool_new_feature)
+      end
     end
 
     context "and the feature is turned off by default" do
@@ -115,6 +119,11 @@ describe OFFS do
         end
         expect(x).to eq 1
       end
+
+      it 'raises an OFFS::FeatureDisabled error for raise_error_unless_we' do
+        expect { OFFS.raise_error_unless_we(:my_cool_new_feature) }.to \
+          raise_error(OFFS::FeatureDisabled, /my_cool_new_feature/)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: offs
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - John Wilger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: injectable_dependencies