flip-flop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 527196b717129538ce2edf0ab15e95afd641ef35
+  data.tar.gz: e264c2af251f924114c26dc433f4a62c7093a2d0
+SHA512:
+  metadata.gz: 3c3c0b6f202b99d9f16e9643f4aff91e6c2a20cb5e25e82a2a09f6ff8e4beeeb845cd79dc092c907e4fc14c2e1868a176a6e41b2cbec139ca2c49b79eea90c51
+  data.tar.gz: 0634f5b6c9079721004902381cd1510ff80e056a9205a767976f32b94d5e5f513a11315a112bf917d01db9d6fdc6a745f11603cb2a13a50ec0a7ce3bc9610cc1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec :name => 'flip-flop'
+
+gem 'rake', '~> 10.4.2'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    flip-flop (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flip-flop!
+  rake (~> 10.4.2)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,148 @@
+FlipFlop
+========
+
+Provide an easy mechanism for turning features on or off, either with dates or just
+a boolean value.
+
+Install
+-------
+
+Add the following to your Gemfile
+
+    gem 'flip-flop'
+
+and run bundler to install
+
+    $ bundle
+
+or
+
+    $ gem install flip-flop
+
+
+Configure
+---------
+
+in `config/initializers/flip-flop.rb`
+
+```ruby
+require 'flip-flop/adapters/yaml'
+FlipFlop.configure do |config|
+  config[:adapter] = FlipFlop::Adapters::YAML
+  config[:yaml_path] = 'config/flip_flop.yml'
+end
+```
+
+and add a YAML file: `config/flip-flop.yml`
+
+for example:
+
+```yaml
+---
+:after_date_example:
+  :type: :after_date
+  :value: 2016-01-01
+:until_date_example:
+  :type: :until_date
+  :value: 2020-01-01
+:percentage_of_time_example:
+  :type: :percentage_of_time
+  :value: 50
+:date_range_example:
+  :type: :date_range
+  :value: !ruby/range
+    begin: 2016-01-01
+    end: 2016-02-01
+    excl: false
+```
+
+Example Usage
+-------------
+
+In a view:
+
+```ruby
+if feature_enabled? :my_cool_feature
+  puts 'Cool'
+else
+  puts ''
+end
+
+```
+
+In a controller:
+
+```ruby
+class SomeController < ApplicationController
+  include FlipFlop::ViewHelpers
+
+  def my_action
+    load_cool_stuff if feature_enabled? :cool_stuff
+  end
+end
+```
+
+Without Rails:
+
+```ruby
+if FlipFlop::get_instance.feature_enabled? :some_feature
+  puts 'something'
+else
+  puts 'something else'
+end
+```
+
+Gates
+-----
+
+* `boolean` &mdash; enable or disable a feature
+* `after_date` &mdash; enable a feature after the date has passed
+* `until_date` &mdash; enable a feature until the date has passed
+* `date_range` &mdash; enable a feature for the duration of the date range
+* `percentage_of_time` &mdash; enable a feature for a given percentage of checks
+
+Adapters
+--------
+
+### Memory
+
+This adapter is primarily used for testing, all configuration is stored in a
+hash in memory.
+
+### YAML
+
+The `FlipFlop::Adapters::YAML` adapter is uses a YAML config file, to store info
+about enabled and disabled features. The YAML file is parsed once when the application is
+loaded. It's quick and easy to use, but it requres a deployment if a feature needs
+to be quickly flipped.
+
+
+Extending FlipFlop
+------------------
+
+### Adding Custom Gates
+
+You can easily add custom gates by adding methods to the `FlipFlop::Gates` module,
+see the below example.
+
+```ruby
+module FlipFlop::Gates
+  def always_on(value)
+    true
+  end
+end
+```
+
+### Adding Custom Adapters
+
+Custom adapters can be added by creating a new adapter class, and then setting the
+adapture when configuring the FlipFlop. See the "Configure" for an example.
+
+Contributing to FlipFlop
+------------------------
+
+* fork
+* branch
+* commit
+* push
+* pull request

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "flip-flop/version"
+
+# gem install pkg/*.gem
+# gem uninstall flip-flop
+desc 'Build gem into the pkg directory'
+task :build do
+  FileUtils.rm_rf('pkg')
+  Dir['*.gemspec'].each do |gemspec|
+    system "gem build #{gemspec}"
+  end
+  FileUtils.mkdir_p('pkg')
+  FileUtils.mv(Dir['*.gem'], 'pkg')
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w(--color)
+end
+
+task :default => :spec

data/flip-flop.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flip-flop/version', __FILE__)
+
+plugin_files = []
+plugin_test_files = []
+
+ignored_files = plugin_files
+ignored_files << ".gitignore"
+ignored_files.uniq!
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brian Kulyk"]
+  gem.email         = ["brian@kulyk.ca"]
+  gem.summary       = %q{Feature flipper}
+  gem.description   = %q{Enable or disable features easily}
+  gem.homepage      = "https://github.com/bkulyk/flip-flop"
+  gem.license       = "MIT"
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n") - ignored_files + ["lib/flip-flop/version.rb"]
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "flip-flop"
+  gem.require_paths = ["lib"]
+  gem.version       = FlipFlop::VERSION
+end

data/lib/flip-flop/adapters/memory.rb

@@ -0,0 +1,33 @@
+require 'date'
+
+module FlipFlop
+  module Adapters
+    module Memory
+      attr_accessor :features
+
+      def after_initialize
+        @features = {}
+      end
+      
+      def get_feature(name)
+        @features[name] || nil
+      end
+
+      def set_feature(name, type, value)
+        @features[name] = {type: type, value: value}
+      end
+
+      def disable_feature(name)
+        set_feature(name, :boolean, false)
+      end
+
+      def feature_type(name)
+        @features[name][:type]
+      end
+
+      def feature_value(name)
+        @features[name][:value]
+      end
+    end
+  end
+end

data/lib/flip-flop/adapters/yaml.rb

@@ -0,0 +1,27 @@
+require 'date'
+
+module FlipFlop
+  module Adapters
+    module YAML
+      include Memory
+
+      DEFAULT_YAML_PATH = 'config/flip_flip.yml'
+
+      def after_initialize
+        @features = load_yaml
+      end
+
+      def yaml_path
+        @config[:yaml_path] || DEFAULT_YAML_PATH
+      end
+
+      def load_yaml
+        ::YAML.load_file(yaml_path) || {}
+      end
+
+      def write_yaml
+        File.open(yaml_path, 'w') { |f| f.write @features.to_yaml }
+      end
+    end
+  end
+end

data/lib/flip-flop/gates.rb

@@ -0,0 +1,25 @@
+require 'date'
+
+module FlipFlop
+  module Gates
+    def boolean(value)
+      value
+    end
+
+    def date_range(value)
+      value.include? Date.today
+    end
+
+    def until_date(value)
+      Date.today < value
+    end
+
+    def after_date(value)
+      Date.today > value
+    end
+
+    def percentage_of_time(value)
+      rand < (value / 100.0)
+    end
+  end
+end

data/lib/flip-flop/railtie.rb

@@ -0,0 +1,9 @@
+require 'flip-flop/view_helpers'
+
+module FlipFlop
+  class Railtie < Rails::Railtie
+    initializer "flip-flop.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/flip-flop/version.rb

@@ -0,0 +1,3 @@
+module FlipFlop
+  VERSION = "0.0.1"
+end

data/lib/flip-flop/view_helpers.rb

@@ -0,0 +1,18 @@
+module FlipFlop
+  module ViewHelpers
+
+    # Check the if a feature should be enabled or not from a view
+    #
+    # Example:
+    #   >> FlipFlop::get_instance.feature_enabled? :some_feature
+    #
+    # Arguments:
+    #   configuration block: (:symbol)
+    #
+    # Returns:
+    #   boolean
+    def feature_enabled?(feature_name)
+      ::FlipFlop::get_instance.feature_enabled? feature_name.to_sym
+    end
+  end
+end

data/lib/flip-flop.rb

@@ -0,0 +1,74 @@
+require 'flip-flop/gates'
+require 'flip-flop/adapters/memory'
+require 'flip-flop/railtie' if defined? Rails
+
+module FlipFlop
+
+  # Get the instnace of FlipFlop or initialize a new one.
+  #
+  # Example:
+  #   >> FlipFlop::get_intance
+  #   => <FlipFlop::FlipFlop>
+  def self.get_instance
+    @flip_flop ||= FlipFlop.new
+  end
+
+  # Initialize and configure FlipFlop for use
+  #
+  # Example:
+  #   >> FlipFlop::configure { |config| config[:adapter] = FlipFlop::Adapters::Memory }
+  #
+  # Arguments:
+  #   configuration block: (block)
+  def self.configure(&block)
+    get_instance.configure(&block)
+  end
+  
+  class FlipFlop
+    attr_reader :config
+
+    # Initialize and configure FlipFlop for use
+    #
+    # Example:
+    #   >> FlipFlop::get_instance.configure { |config| config[:adapter] = FlipFlop::Adapters::Memory }
+    #
+    # Arguments:
+    #   configuration block: (block)
+    def configure
+      @config ||= {}
+      yield @config
+
+      initialize_adapter
+    end
+
+    # Check the if a feature should be enabled or not
+    #
+    # Example:
+    #   >> FlipFlop::get_instance.feature_enabled? :some_feature
+    #
+    # Arguments:
+    #   configuration block: (:symbol)
+    #
+    # Returns:
+    #   boolean
+    def feature_enabled?(name)
+      public_send feature_type(name), feature_value(name)
+    rescue
+      false
+    end
+
+    private
+
+    # If no adapter has been configured, use memory, then run the `after_initialize`
+    # method defined in the adapter if it's there
+    def initialize_adapter
+      # if no adapter has been initialized, use memory adapter
+      config[:adapter] ||= Adapters::Memory
+
+      extend config[:adapter]
+      after_initialize if respond_to? :after_initialize
+    end
+
+    include Gates
+  end
+end

data/spec/lib/view_helpers_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'flip-flop/view_helpers'
+
+class DummyController
+  include FlipFlop::ViewHelpers
+end
+
+describe DummyController do  
+
+  describe '#feature_enabled?' do
+    it 'should return false if nothing has been set' do
+      expect(subject.feature_enabled? :asdf).to be_falsey
+    end
+
+    context 'boolean gate' do
+      before :each do
+        ::FlipFlop::get_instance.set_feature(:asdf, :boolean, :true)
+      end
+
+      it 'should return true if the feature has been enabled' do
+        expect(subject.feature_enabled? :asdf).to be_truthy
+      end
+
+      it 'should return false if the feature has been disabled' do
+        ::FlipFlop::get_instance.disable_feature(:asdf)
+        expect(subject.feature_enabled? :asdf).to be_falsey
+      end
+    end
+
+    context 'until_date gate' do
+      it 'should return true if the feature has been set to expire in the future' do
+        ::FlipFlop::get_instance.set_feature(:something, :until_date, Date.today + 3)
+        expect(subject.feature_enabled? :something).to be_truthy
+      end
+
+      it 'should return false if the feature has been set to expire in the past' do
+        FlipFlop::get_instance.set_feature(:something, :until_date, Date.today - 3)
+        expect(subject.feature_enabled? :something).to be_falsey
+      end
+    end
+
+    context 'after_date gate' do
+      it 'should return true if the feature has been set to expire after a date in the past' do
+        FlipFlop::get_instance.set_feature(:blah, :after_date, Date.today - 3)
+        expect(subject.feature_enabled? :blah).to be_truthy
+      end
+
+      it 'should return false if the feature has been set to enable after a date in the future' do
+        FlipFlop::get_instance.set_feature(:blah, :after_date, Date.today + 3)
+        expect(subject.feature_enabled? :blah).to be_falsey
+      end
+    end
+
+    context 'date range gate' do
+      it 'feature should be enabled if current date is in the date range' do
+        FlipFlop::get_instance.set_feature(:ranged, :date_range, (Date.today - 1)..(Date.today + 1))
+        expect(subject.feature_enabled? :ranged).to be_truthy
+      end
+
+      it 'feature should be disabled if range not started yet' do
+        ::FlipFlop::get_instance.set_feature(:ranged, :date_range, (Date.today + 1)..(Date.today + 2))
+        expect(subject.feature_enabled? :ranged).to be_falsey
+      end
+
+      it 'feature should be disabled if range is past' do
+        ::FlipFlop::get_instance.set_feature(:ranged, :date_range, (Date.today - 4)..(Date.today - 2))
+        expect(subject.feature_enabled? :ranged).to be_falsey
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.expand_path('../lib', __FILE__))
+
+require 'pathname'
+FlopFlopRoot = Pathname(__FILE__).dirname.join('..').expand_path
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup(:default)
+
+require 'flip-flop'
+
+RSpec.configure do |config|
+  FlipFlop.configure do
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: flip-flop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Kulyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-21 00:00:00.000000000 Z
+dependencies: []
+description: Enable or disable features easily
+email:
+- brian@kulyk.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- flip-flop.gemspec
+- lib/flip-flop.rb
+- lib/flip-flop/adapters/memory.rb
+- lib/flip-flop/adapters/yaml.rb
+- lib/flip-flop/gates.rb
+- lib/flip-flop/railtie.rb
+- lib/flip-flop/version.rb
+- lib/flip-flop/view_helpers.rb
+- spec/lib/view_helpers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bkulyk/flip-flop
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Feature flipper
+test_files:
+- spec/lib/view_helpers_spec.rb
+- spec/spec_helper.rb