groupme-paddock 0.2.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Pivotal Labs
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Paddock
+
+    "...even Nedry knew better than to mess with the raptor fences."
+
+Paddock is a feature switch system.
+
+Define which features should be used in certain environments.
+
+## Setup
+
+Put this somewhere like: `config/initializers/paddock.rb`
+
+    include Paddock
+
+    Paddock(Rails.env) do
+      enable  :phone_system,  :in => [:development, :test]
+      enable  :door_locks,    :in => :development
+      enable  :raptor_fences
+      disable :cryo_security
+      disable :tyranosaur_fences, :in => :production
+    end
+
+You name it, we got it.
+
+## Usage
+
+    # Check if feature is enabled
+    if paddock(:perimeter_fence)
+      # do work
+    end
+
+    # Guard a block
+    paddock(:perimeter_fence) do
+      # do work
+    end
+
+This is a unix system. I know this.
+
+## Testing
+
+This might need some work.
+
+You can define which features are enabled in a test:
+
+    before(:each) do
+      Paddock.enable :feature_i_am_testing
+    end
+
+You think that kind of automation is easy? Or cheap?
+
+## Authors
+
+We're not computer nerds. We prefer to be called "hackers."
+
+* Pat Nakajima
+* Brandon Keene
+
+![system secured](http://ak2.static.dailymotion.com/static/video/024/680/8086420:jpeg_preview_large.jpg)
+
+(c) Copyright 2010 Pivotal Labs, see LICENSE

data/lib/paddock.rb

@@ -0,0 +1,69 @@
+module Paddock
+  class FeatureNotFound < StandardError
+  end
+
+  class Feature
+    def self.add(name, envs, disabled=false)
+      @features ||= {}
+      @features[name] = new(name, envs, disabled)
+    end
+
+    def self.get(name)
+      (@features ||= {})[name] || raise(Paddock::FeatureNotFound.new("#{name} is not a valid feature."))
+    end
+
+    def initialize(name, envs, disabled)
+      @name, @envs, @disabled = name, envs, disabled
+    end
+
+    def enabled?
+      result = true if @envs == :all
+      result ||= Array(@envs).map { |env| env.to_sym }.include?(Paddock.environment.to_sym)
+      @disabled ? (!result) : result
+    end
+  end
+
+  def self.environment=(env)
+    @environment = env
+  end
+
+  def self.environment
+    @environment
+  end
+
+  def self.features(&block)
+    @block = block
+    instance_eval(&block)
+  end
+
+  def self.reset!
+    if block = @block
+      features(&block)
+    else
+      raise "No paddock block defined!"
+    end
+  end
+
+  def self.enable(name, options={})
+    Paddock::Feature.add(name, (options[:in] || :all))
+  end
+
+  def self.disable(name, options={})
+    Paddock::Feature.add(name, (options[:in] || :all), :disabled)
+  end
+
+  def paddock(name)
+    enabled = Paddock::Feature.get(name).enabled?
+    enabled && yield if block_given?
+    enabled
+  end
+end
+
+def Paddock(env, &block)
+  if block_given?
+    ::Paddock.environment = env
+    ::Paddock.features(&block)
+  else
+    ::Paddock
+  end
+end

data/spec/paddock_spec.rb

@@ -0,0 +1,211 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib paddock])
+
+describe Paddock('development') do
+  include Paddock
+
+  it "has an environment" do
+    Paddock.environment = "development"
+    Paddock.environment.should == "development"
+  end
+
+  it "raises a FeatureNotFound error when the feature don't not exist none" do
+    proc {
+      paddock(:raptor_fences)
+    }.should raise_error(Paddock::FeatureNotFound)
+  end
+
+  describe "defining enabled features" do
+    context "when not specifying environments" do
+      before(:each) do
+        Paddock('development') do
+          enable :perimeter_fence
+        end
+      end
+
+      it "runs the feature block always" do
+        called = false
+        paddock(:perimeter_fence) { called = true }
+        called.should be_true
+      end
+
+      it "always returns true on feature check" do
+        paddock(:perimeter_fence).should be_true
+      end
+    end
+
+    context "when specifying environment" do
+      before(:each) do
+        Paddock('development') do
+          enable :perimeter_fence, :in => :development
+        end
+      end
+
+      context "when in appropriate environment" do
+        before(:each) do
+          Paddock.environment = 'development'
+        end
+
+        it "runs the feature block" do
+          called = false
+          paddock(:perimeter_fence) { called = true }
+          called.should be_true
+        end
+
+        it "returns true from the feature check" do
+          paddock(:perimeter_fence).should be_true
+        end
+
+        it "is indifferent to strings/symbols" do
+          Paddock('development') do
+            enable :perimeter_fence, :in => 'development'
+          end
+
+          called = false
+          paddock(:perimeter_fence) { called = true }
+          called.should be_true
+        end
+      end
+    end
+
+    context "when specifying multiple environments" do
+      before(:each) do
+        Paddock('development') do
+          enable :perimeter_fence, :in => [:development, :test]
+        end
+      end
+
+      context "when in appropriate environment" do
+        before(:each) do
+          Paddock.environment = 'development'
+        end
+
+        it "runs the feature block" do
+          called = false
+          paddock(:perimeter_fence) { called = true }
+          called.should be_true
+        end
+
+        it "returns true from the feature check" do
+          paddock(:perimeter_fence).should be_true
+        end
+
+        it "is indifferent to strings/symbols" do
+          Paddock('development') do
+            enable :perimeter_fence, :in => %w[development test]
+          end
+
+          called = false
+          paddock(:perimeter_fence) { called = true }
+          called.should be_true
+        end
+      end
+
+      context "when not in appropriate environment" do
+        before(:each) do
+          Paddock.environment = 'production'
+        end
+
+        it "does not run the feature block when not in an appropriate environment" do
+          called = false
+          paddock(:perimeter_fence) { called = true }
+          called.should be_false
+        end
+
+        it "returns false from the feature check" do
+          paddock(:perimeter_fence).should be_false
+        end
+      end
+    end
+  end
+
+  describe "disabling features" do
+    before(:each) do
+      Paddock('development') do
+        disable :perimeter_fence
+      end
+    end
+
+    it "does not run the feature block when not in an appropriate environment" do
+      called = false
+      paddock(:perimeter_fence) { called = true }
+      called.should be_false
+    end
+
+    it "returns false from the feature check" do
+      paddock(:perimeter_fence).should be_false
+    end
+  end
+
+  describe "disabling features in certain environments" do
+    before(:each) do
+      Paddock('production') do
+        disable :perimeter_fence, :in => :production
+      end
+    end
+
+    it "does not run the feature block when not in an appropriate environment" do
+      called = false
+      paddock(:perimeter_fence) { called = true }
+      called.should be_false
+    end
+
+    it "returns false from the feature check" do
+      paddock(:perimeter_fence).should be_false
+    end
+
+    it "is indifferent to strings/symbols" do
+      Paddock('development') do
+        disable :perimeter_fence, :in => 'production'
+      end
+
+      called = false
+      paddock(:perimeter_fence) { called = true }
+      called.should be_true
+    end
+  end
+
+  describe "using disabled features in different environment" do
+    before(:each) do
+      Paddock('development') do
+        disable :perimeter_fence, :in => :production
+      end
+    end
+
+    it "does not run the feature block when not in an appropriate environment" do
+      called = false
+      paddock(:perimeter_fence) { called = true }
+      called.should be_true
+    end
+
+    it "returns false from the feature check" do
+      paddock(:perimeter_fence).should be_true
+    end
+
+    it "is indifferent to strings/symbols" do
+      Paddock('development') do
+        disable :perimeter_fence, :in => %w[production other]
+      end
+
+      called = false
+      paddock(:perimeter_fence) { called = true }
+      called.should be_true
+    end
+  end
+
+  describe "resetting changes" do
+    before(:each) do
+      Paddock('development') do
+        disable :disabled_feature
+        enable :enabled_feature
+      end
+    end
+
+    it "restores original feature behavior" do
+      Paddock.disable :enabled_feature
+      paddock(:enabled_feature).should be_false
+
+      Paddock.reset!
+      paddock(:enabled_feature).should be_true
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: groupme-paddock
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Pat Nakajima & Brandon Keene
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-05 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: nyc+github@pivotallabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- lib/paddock.rb
+- spec/paddock_spec.rb
+has_rdoc: true
+homepage: http://github.com/groupme/paddock
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Paddock is an environment-based feature switch system.
+test_files: []
+