offs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7f44fb139c3f2a88d2510ee22559e18037d9a32
+  data.tar.gz: 0b224e3575e8f241ffec5e5f2a370b2d402ba565
+SHA512:
+  metadata.gz: fcea828f9ec2c1819e231f8964083575d8f1d83277ee3371826d62c1b4057d6487e6a5f6da178b9c3621dd7c0616d04539ab2c8534d22205ef042238559b9ee0
+  data.tar.gz: 19b9c2ccbb99a95b397421a2c17731408cf73a6502098d7bb3ab1a2acf6412d8c22200b609759e0b1f11db1744107ddff8be2c583fa69ed964c4fcb7f9a837cc

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in offs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Wilger
+
+MIT License
+
+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,90 @@
+# OFFS Feature Flagging System
+
+OFFS allows new features-in-progress to be constantly integrated with
+a project's master or production code branch by allowing the code to
+take different branches depending on how the feature flags are
+configured.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'offs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install offs
+
+## Usage
+
+Let's say you are working on an application and are going to add a hot
+new feature that is virtually guaranteed to make you millions of
+dollars. You want to continuously integrate the new code into the master
+branch of the repository to avoid merging-headaches down the line (there
+are other developers working on other features at the same time), but
+you need to keep the master branch in a deployable state. OFFS allows
+you to do just that.
+
+First, you need to decide on the name for your feature flag and tell
+OFFS about it when your application loads. For instance, in a Rails app,
+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
+```
+
+You've now defined the flags that your app will use, and you've given
+each flag a default value where `true` means you will use the new
+feature and `false` means you will use the old code instead.
+
+When running your application, you can override the default flag setting
+by setting environment variables. For instance, to reverse both of the
+flags above when running `rake` on your application code, you would do
+this:
+
+```sh
+USE_MY_MILLION_DOLLAR_IDEA=1 USE_THIS_MOSTLY_DONE_FEATURE=0 rake
+```
+
+In your code, simply do the following in each place where you have new
+and/or existing code that should be run or not run depending on the
+feature flag setting:
+
+```ruby
+class Foo
+  def do_something
+    OFFS.so_you_want_to(:use_my_million_dollar_idea) do |you|
+      you.would_like_to do
+        # this is where you put the new code that will run when the flag
+        # is *on*.
+      end
+
+      you.may_still_need_to do
+        # this is where you put the old code that will run when the flag
+        # is *off*
+      end
+    end
+  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.
+
+## Contributing
+
+1. Fork it ( https://github.com/jwilger/offs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/offs/version.rb

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

data/lib/offs.rb

@@ -0,0 +1,64 @@
+require "offs/version"
+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 }
+
+  def initialize(flag, options={})
+    initialize_dependencies options[:dependencies]
+    self.flag = flag
+  end
+
+  def so_you_want_to(&block)
+    block.call(self)
+  end
+
+  def would_like_to(&block)
+    return unless flag_is_on?
+    block.call
+  end
+
+  def may_still_need_to(&block)
+    return if flag_is_on?
+    block.call
+  end
+
+  private
+
+  attr_reader :flag
+
+  def flag_is_on?
+    !!feature_flags[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
+  end
+end

data/offs.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'offs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "offs"
+  spec.version       = OFFS::VERSION
+  spec.authors       = ["John Wilger"]
+  spec.email         = ["johnwilger@gmail.com"]
+  spec.summary       = %q{OFFS Feature Flagging System}
+  spec.description   = %q{OFFS provides a means to demarcate code that is
+                          related to new features as well as the old code path
+                          and switch between the two depending on
+                          configuration.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "injectable_dependencies"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/offs_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe OFFS do
+  it 'has a version number' do
+    expect(described_class::VERSION).not_to be nil
+  end
+
+  subject { described_class.new(flag, dependencies: dependencies) }
+
+  let(:flag) { :my_cool_new_feature }
+
+  let(:dependencies) {{
+    feature_flags: feature_flags
+  }}
+
+  let(:feature_flags) {{
+    :my_cool_new_feature => feature_status
+  }}
+
+  let(:feature_status) { true }
+
+  context 'when the specified feature flag is not defined' do
+    let(:feature_flags) {{}}
+
+    it 'raises an error' do
+      expect{ subject.so_you_want_to {} }.to \
+        raise_error(OFFS::UndefinedFlagError,
+                    "The #{flag} flag has not been defined.")
+    end
+  end
+
+  context "when the specified feature flag is defined" do
+    let(:would_like_to_blk) { ->{} }
+    let(:may_still_need_to_blk) { ->{} }
+
+    after(:each) do
+      subject.so_you_want_to do |you|
+        you.would_like_to(&would_like_to_blk)
+        you.may_still_need_to(&may_still_need_to_blk)
+      end
+    end
+
+    context "and the feature is turned on by default" do
+      it 'executes the would_like_to block' do
+        expect(would_like_to_blk).to receive(:call)
+      end
+      it 'does not execute the may_still_need_to block' do
+        expect(may_still_need_to_blk).to_not receive(:call)
+      end
+    end
+
+    context "and the feature is turned off by default" do
+      let(:feature_status) { false }
+
+      it "executes the may_still_need_to block" do
+        expect(may_still_need_to_blk).to receive(:call)
+      end
+      it 'does not execute the would_like_to block' do
+        expect(would_like_to_blk).to_not receive(:call)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'offs'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: offs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Wilger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: injectable_dependencies
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  OFFS provides a means to demarcate code that is
+                            related to new features as well as the old code path
+                            and switch between the two depending on
+                            configuration.
+email:
+- johnwilger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/offs.rb
+- lib/offs/version.rb
+- offs.gemspec
+- spec/offs_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: OFFS Feature Flagging System
+test_files:
+- spec/offs_spec.rb
+- spec/spec_helper.rb