corral 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 619742d68fba82f665cb0f3e35ba09acf35e5ceb
-  data.tar.gz: 493acbc382bde9159cd33ac345818351bf64ea7a
+  metadata.gz: d16e636469afb7e4a608fd6f34d8c479c9d7b366
+  data.tar.gz: 0d11cd106cc36d68273322e7f0c2c3e5c2bea527
 SHA512:
-  metadata.gz: 79e9d8fd56a693200e2964d7c40ca4429ebea1449f94b471cc21a324b85e39745c32ddcb8b7918a5a18e961a20a9490f032579b1778291a61b46f84a5a433605
-  data.tar.gz: 3553a67dffe46df119d4b1bad3569b8c3e6aa17cf8206685ce6327f684400cde0ee7a060ba0816faa5093b32d76324987465dc4e401e46d2e7b4fc5e9672faaf
+  metadata.gz: f3fb14dfebbdeb58615fde4e71838a7b81205091260b21db78e3b6da791909adacbf867ecd37229e3537101af47eaeed4e7fc0bda314931b6e8339efa28c0fda
+  data.tar.gz: 78029aad67dc1a06fb947003de11c422b25a177fd4912eff4e2876497c0ba82a690fafcb9a2ec50bb2f1b9748a4f416842ff1e8f84f9a77e292762a1639849d3

data/README.md

@@ -22,21 +22,38 @@ Put this somewhere like: `config/initializers/corral.rb`
 ```ruby
 include Corral
 
-corral do
+# Pass an environment to use the `in` option...
+Corral.corral(Rails.env) do
   disable :torpedoes, when: -> { true }
-  disable :fun_and_games, when: -> { Rails.env.production? }
+  disable :fun_and_games, in: [:staging, :production]
   disable :cupcakes, if: ->(person) { person == "Bryan" }
 end
 ```
 
 ("when" and "if" mean the same thing. Use whichever makes you happy.)
 
+If you don't mind polluting your global namespace and want to more
+easily refer to these methods, you can include `Corral::Helpers`
+
+```ruby
+include Corral::Helpers
+
+corral(Rails.env) do
+  disable :caching, in: [:development, :test, :staging]
+  disable :crying, when: ->(user) { user.birthday == Date.today }
+end
+```
 
 ## Usage
 
 ```ruby
+# If you've included Corral::Helpers
 fire! if enabled?(:torpedoes)
 sulk if disabled?(:cupcakes, "Bryan") # And I don't even *like* sweets!
+
+# If you've only included Corral
+fire! if Corral.enabled?(:torpedoes)
+sulk if Corral.disabled?(:cupcakes, "Bryan")
 ```
 
 ## Installation

data/lib/corral/feature.rb

@@ -0,0 +1,20 @@
+module Corral
+  class Feature
+    attr_reader :condition
+
+    def initialize(feature, condition, disabled)
+      @feature = feature
+      @condition = condition
+      @disabled = disabled
+    end
+
+    def self.push(name, condition, disabled = true)
+      @features ||= {}
+      @features[name] = new(name, condition, disabled)
+    end
+
+    def self.get(name)
+      (@features ||= {})[name]
+    end
+  end
+end

data/lib/corral/helpers.rb

@@ -0,0 +1,11 @@
+module Corral
+  module Helpers
+    %w(corral disable enabled? disabled?).each do |name|
+      class_eval <<-EOS
+        def #{name}(*args, &block)
+          Corral.#{name}(*args, &block)
+        end
+      EOS
+    end
+  end
+end

data/lib/corral/version.rb

@@ -1,3 +1,3 @@
 module Corral
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/corral.rb

@@ -1,53 +1,54 @@
 require "corral/version"
+require "corral/feature"
+require "corral/helpers"
 
 module Corral
-  class Feature
-    attr_reader :condition
-
-    def initialize(feature, condition, disabled)
-      @feature = feature
-      @condition = condition
-      @disabled = disabled
-    end
+  def self.environment
+    @environment
+  end
 
-    def self.push(name, condition, disabled = true)
-      @features ||= {}
-      @features[name] = new(name, condition, disabled)
-    end
+  def self.environment=(env)
+    @environment = env.to_sym
+  end
 
-    def self.get(name)
-      (@features ||= {})[name]
-    end
+  def self.corral(env = nil, &block)
+    self.environment = env.to_s
+    gather_features(&block)
   end
 
-  module Helpers
-    def corral(&block)
-      instance_eval(&block)
-    end
+  def self.disable(feature, options = {})
+    environments = options[:in] and
+      return environment_override(feature, *environments)
+
+    condition = options[:when] || options[:if]
 
-    def disabled?(feature, argument = nil)
-      !enabled?(feature, argument)
+    if condition && !condition.respond_to?(:call)
+      raise "'when' or 'if' condition must be a callable object"
     end
 
-    def enabled?(feature, argument = nil)
-      feature = Feature.get(feature)
-      return false unless feature && (condition = feature.condition)
+    Feature.push(feature, condition)
+  end
 
-      if argument
-        !condition.call(argument)
-      else
-        !condition.call
-      end
-    end
+  def self.disabled?(feature, *arguments)
+    !self.enabled?(feature, *arguments)
+  end
+
+  def self.enabled?(feature, *arguments)
+    (feature = Feature.get(feature)) && (condition = feature.condition) or
+      return false
 
-    def disable(feature, options = {})
-      condition = options[:when] || options[:if]
+    !condition.call(*arguments)
+  end
 
-      if condition && !condition.respond_to?(:call)
-        raise "'when' or 'if' condition must be a callable object"
-      end
+  private
 
-      Feature.push(feature, condition)
-    end
+  def self.gather_features(&block)
+    instance_eval(&block)
+  end
+
+  def self.environment_override(feature, *environments)
+    envs = environments.map(&:to_sym)
+    condition = -> { envs.any? { |env| env == self.environment } }
+    Feature.push(feature, condition)
   end
 end

data/spec/corral_spec.rb

@@ -10,6 +10,34 @@ describe Corral do
       end
 
       context "when given known features" do
+        context "when passed an environment in an 'in' option" do
+          context "when the environment matches the condition" do
+            before do
+              corral("development") do
+                disable :caching, in: :development
+                disable "expiry_headers", in: :development
+              end
+            end
+
+            it "disables the feature" do
+              disabled?(:caching).should be_true
+              disabled?(:expiry_headers).should be_true
+            end
+          end
+
+          context "when the environment does not match any of the conditions" do
+            before do
+              corral("development") do
+                disable :debug_mode, in: [:production, :test]
+              end
+            end
+
+            it "does not disable the feature" do
+              disabled?(:debug_mode).should be_false
+            end
+          end
+        end
+
         context "when given callable 'when' or 'if' options" do
           context "when the conditions are true" do
             before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: corral
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bryan Woods
@@ -53,6 +53,8 @@ files:
 - Rakefile
 - corral.gemspec
 - lib/corral.rb
+- lib/corral/feature.rb
+- lib/corral/helpers.rb
 - lib/corral/version.rb
 - spec/corral_spec.rb
 - spec/spec_helper.rb