feature_gate 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 255bbc8862c9ffe2ee0423555cb80fda831609ee
-  data.tar.gz: 0f4de315061a2d378a224915a6282c1a4d60b60a
+  metadata.gz: e187e63d24ae3b5361f106b9bec9447d2b0d18ac
+  data.tar.gz: 4a194e22810c9e87b39a16b9a725f6743dfac712
 SHA512:
-  metadata.gz: 0794de4ccd8bc0b87a78d43637bc2175b219e201c9fd099134fef35bde34cf06989105951144bdad61e47ece2d42de266b2f645e0e5706a8ca2a41a61f568f40
-  data.tar.gz: db1220d039ea0eed0db994a4b0578077e473527a5a85327c4bf0bec7e5bdb749a55ecd77158a83c7894ef5c405f1bdf37e279574500d52cd4c7d743438798f55
+  metadata.gz: 6c32a616311c119c7e68d69192c5207ce82b14ecc0a373168a13f42b73f85d63fb81a67e7bfd4728047885b2b98129ff941bfdd1dee992b4182d0207edd009cb
+  data.tar.gz: 771f991a6fc664aff138a9ad627b27f45a4b994e3668fd3acfdfbf4b1d81530f0c84588dc209edf990b537781e24ffbc069cbf5c7900e1926a81461a92e967e1

data/.gitignore

@@ -1,3 +1,4 @@
 # ignore .gem files
 *.gem
 .DS_Store
+log/

data/Gemfile.lock

@@ -1,93 +1,135 @@
 PATH
   remote: .
   specs:
-    feature_gate (0.0.3)
-      rails (~> 3.2.18)
+    feature_gate (0.0.7)
+      rails (~> 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (3.2.22.2)
-      actionpack (= 3.2.22.2)
-      mail (~> 2.5.4)
-    actionpack (3.2.22.2)
-      activemodel (= 3.2.22.2)
-      activesupport (= 3.2.22.2)
-      builder (~> 3.0.0)
+    actionmailer (4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.6)
+      actionview (= 4.2.6)
+      activesupport (= 4.2.6)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
       erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.5)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.2.1)
-    activemodel (3.2.22.2)
-      activesupport (= 3.2.22.2)
-      builder (~> 3.0.0)
-    activerecord (3.2.22.2)
-      activemodel (= 3.2.22.2)
-      activesupport (= 3.2.22.2)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.22.2)
-      activemodel (= 3.2.22.2)
-      activesupport (= 3.2.22.2)
-    activesupport (3.2.22.2)
-      i18n (~> 0.6, >= 0.6.4)
-      multi_json (~> 1.0)
-    arel (3.0.3)
-    builder (3.0.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.6)
+      activesupport (= 4.2.6)
+      globalid (>= 0.3.0)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
     erubis (2.7.0)
-    hike (1.2.3)
+    factory_girl (4.7.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.7.0)
+      factory_girl (~> 4.7.0)
+      railties (>= 3.0.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
     i18n (0.7.0)
-    journey (1.0.4)
     json (1.8.3)
-    mail (2.5.4)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.25.1)
-    multi_json (1.11.3)
-    polyglot (0.3.5)
-    rack (1.4.7)
-    rack-cache (1.6.1)
-      rack (>= 0.4)
-    rack-ssl (1.3.4)
-      rack
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (3.2.22.2)
-      actionmailer (= 3.2.22.2)
-      actionpack (= 3.2.22.2)
-      activerecord (= 3.2.22.2)
-      activeresource (= 3.2.22.2)
-      activesupport (= 3.2.22.2)
-      bundler (~> 1.0)
-      railties (= 3.2.22.2)
-    railties (3.2.22.2)
-      actionpack (= 3.2.22.2)
-      activesupport (= 3.2.22.2)
-      rack-ssl (~> 1.3.2)
+    rails (4.2.6)
+      actionmailer (= 4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      activemodel (= 4.2.6)
+      activerecord (= 4.2.6)
+      activesupport (= 4.2.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.6)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.6)
+      actionpack (= 4.2.6)
+      activesupport (= 4.2.6)
       rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
+      thor (>= 0.18.1, < 2.0)
     rake (11.1.2)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    sprockets (2.2.3)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.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-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    sprockets (3.6.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.4)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
     sqlite3 (1.3.11)
     thor (0.19.1)
-    tilt (1.4.1)
-    treetop (1.4.15)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.49)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  factory_girl_rails (~> 4.5)
   feature_gate!
+  rspec-rails (~> 3.1)
   sqlite3 (~> 1.3)

data/README.md

@@ -1,2 +1,50 @@
 # feature_gate
-A gem to help toggle feature gates on and off
+
+A gem to help toggle features on and off in Rails applications without having to re-deploy.
+
+## Installation
+
+Include gem in Gemfile:
+
+    gem 'feature_gate'
+
+Run generator to create the migration needed
+
+    rails generate feature_gate
+
+Migrate to create the table in your DB:
+
+    rake db:migrate
+
+## Usage
+
+All gates are closed by default, meaning the features you gate will be hidden until you toggle the gates open.
+
+In view files:
+
+    <% FeatureGate::Manager.gate('gate-name') do %>
+      <h1>This is my gated content</h1>
+      <p>I am not seen if the gate is on</p>
+    <% end %>
+
+In controller actions:
+
+    def index
+      FeatureGate::Manager.gate_page('gate-name') # 404s if gate is closed
+    end
+
+To deploy your feature:
+
+    FeatureGate::Manager.open!('gate-name')
+
+To gate your feature:
+
+    FeatureGate::Manager.close!('gate-name')
+
+To see the names of all opened gates:
+
+    FeatureGate::Manager.opened_gates
+
+To see the names of all closed gates:
+
+    FeatureGate::Manager.closed_gates

data/app/models/feature_gate/gated_feature.rb

@@ -0,0 +1,19 @@
+module FeatureGate
+  class GatedFeature < ActiveRecord::Base
+    validates :name, presence: true
+    validates :gated, inclusion: { in: [true, false] }
+
+    scope :opened, -> { where(gated: false) }
+    scope :closed, -> { where(gated: true) }
+
+    def deploy_feature!
+      self.gated = false
+      save!
+    end
+
+    def gate_feature!
+      self.gated = true
+      save!
+    end
+  end
+end

data/app/models/feature_gate/manager.rb

@@ -0,0 +1,35 @@
+module FeatureGate
+  class Manager
+    def self.gate_page(name)
+      gated_feature = GatedFeature.where(name: name).first_or_create
+      if gated_feature.gated?
+        raise ActionController::RoutingError.new('Not Found')
+      end
+    end
+
+    def self.gate(name)
+      gated_feature = GatedFeature.where(name: name).first_or_create
+      if !gated_feature.gated?
+        yield
+      end
+    end
+
+    def self.opened_gates
+      GatedFeature.opened.pluck(:name)
+    end
+
+    def self.closed_gates
+      GatedFeature.closed.pluck(:name)
+    end
+
+    def self.open!(name)
+      gated_feature = GatedFeature.find_by_name!(name)
+      gated_feature.deploy_feature!
+    end
+
+    def self.close!(name)
+      gated_feature = GatedFeature.find_by_name!(name)
+      gated_feature.gate_feature!
+    end
+  end
+end

data/feature_gate.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.summary     = 'A gem to toggle feature gates on and off'
   s.description = 'A gem to toggle feature gates on and off'
   s.authors     = ['Tiffany Huang']
-  s.email       = 'little.huang@gmail.'
+  s.email       = 'little.huang@gmail.com'
   s.files       = `git ls-files`.split("\n")
   s.homepage    = 'https://github.com/tiffling/feature_gate'
   s.license     = 'MIT'
@@ -16,4 +16,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rails', '~> 4.0'
   s.add_development_dependency('sqlite3', '~> 1.3')
+  s.add_development_dependency('rspec-rails', '~> 3.1')
+  s.add_development_dependency('factory_girl_rails', '~> 4.5')
 end

data/lib/feature_gate/version.rb

@@ -1,3 +1,3 @@
 module FeatureGate
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.0.8'.freeze
 end

data/lib/feature_gate.rb

@@ -9,30 +9,6 @@ module FeatureGate
   def self.setup
     yield self
   end
-
-  def self.gate_page(name)
-    gated_feature = GatedFeature.where(name: name).first_or_create
-    if gated_feature.gated?
-      raise ActiveRecord::RecordNotFound
-    end
-  end
-
-  def self.gate(name)
-    gated_feature = GatedFeature.where(name: name).first_or_create
-    if !gated_feature.gated?
-      yield
-    end
-  end
-
-  def self.open!(name)
-    gated_feature = GatedFeature.find_by_name!(name)
-    gated_feature.deploy_feature!
-  end
-
-  def self.close!(name)
-    gated_feature = GatedFeature.find_by_name!(name)
-    gated_feature.gate_feature!
-  end
 end
 
 require 'feature_gate/engine'

data/spec/factories.rb

@@ -0,0 +1,10 @@
+FactoryGirl.define do
+  factory :gated_feature, class: 'FeatureGate::GatedFeature' do
+    sequence(:name){ |n| "name_#{n}" }
+    gated true
+
+    trait :open do
+      gated false
+    end
+  end
+end

data/spec/fake_app.rb

@@ -0,0 +1,17 @@
+# Classes required for the tests
+# class User; end
+# module ApplicationHelper; def current_user; raise; end; end
+
+# Create a rails app
+module FeatureGate
+  class Application < Rails::Application
+    config.secret_key_base = 'test'
+    config.paths['config/database'] = ['spec/support/database.yml']
+    config.eager_load = false
+  end
+end
+FeatureGate::Application.initialize!
+
+# Run migrations
+require_relative '../lib/generators/feature_gate/templates/migration'
+CreateGatedFeatures.suppress_messages { CreateGatedFeatures.new.change }

data/spec/models/feature_gate/manager_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe FeatureGate::Manager do
+  describe '.gate' do
+    it 'if the gate for the given name does not exist, create the gate and return nil' do
+      expect do
+        result = FeatureGate::Manager.gate('new_gate') do
+          'foobar'
+        end
+        expect(result).to eq nil
+      end.to change{ FeatureGate::GatedFeature.count }.by(1)
+    end
+
+    it 'if the gate does exist and it is closed, return nil' do
+      create(:gated_feature, name: 'new_gate')
+
+      expect do
+        result = FeatureGate::Manager.gate('new_gate') do
+          'foobar'
+        end
+        expect(result).to eq nil
+      end.not_to change{ FeatureGate::GatedFeature.count }
+    end
+
+    it 'if the gate does exist and it is opened, yield' do
+      create(:gated_feature, :open, name: 'new_gate')
+
+      expect do
+        result = FeatureGate::Manager.gate('new_gate') do
+          'foobar'
+        end
+        expect(result).to eq 'foobar'
+      end.not_to change{ FeatureGate::GatedFeature.count }
+    end
+  end
+
+  describe '.gate_page' do
+    it 'if the gate for the given name does not exist, create the gate and raise not found' do
+      expect do
+        FeatureGate::Manager.gate_page('new_gate')
+      end.to raise_error(ActionController::RoutingError)
+    end
+
+    it 'if the gate does exist and it is closed, raise not found' do
+      create(:gated_feature, name: 'new_gate')
+
+      expect do
+        FeatureGate::Manager.gate_page('new_gate')
+      end.to raise_error(ActionController::RoutingError)
+    end
+
+    it 'if the gate does exist and it is opened do not raise' do
+      create(:gated_feature, :open, name: 'new_gate')
+
+      expect do
+        FeatureGate::Manager.gate_page('new_gate')
+      end.not_to raise_error(ActionController::RoutingError)
+    end
+  end
+
+  describe '.opened_gates' do
+    it 'returns names of all opened gates' do
+      opened_gates = create_list(:gated_feature, 2, :open)
+      create_list(:gated_feature, 2)
+
+      expect(FeatureGate::Manager.opened_gates).to match_array(opened_gates.map(&:name))
+    end
+  end
+
+  describe '.closed_gates' do
+    it 'returns names of all closed gates' do
+      create_list(:gated_feature, 2, :open)
+      closed_gates = create_list(:gated_feature, 2)
+
+      expect(FeatureGate::Manager.closed_gates).to match_array(closed_gates.map(&:name))
+    end
+  end
+
+  describe '.open!' do
+    it 'marks a given gate as open' do
+      gate = create(:gated_feature)
+      FeatureGate::Manager.open!(gate.name)
+      expect(gate.reload).not_to be_gated
+    end
+  end
+
+  describe '.close!' do
+    it 'marks a given gate as closed' do
+      gate = create(:gated_feature, :open)
+      FeatureGate::Manager.close!(gate.name)
+      expect(gate.reload).to be_gated
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+ENV['RAILS_ENV'] = 'test'
+
+require 'rails/all'
+require 'rspec/rails'
+require 'fake_app'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+require 'factory_girl'
+require 'factories'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+  config.include Rails.application.routes.url_helpers
+  config.infer_spec_type_from_file_location!
+  config.default_formatter = 'doc'
+  config.before(:each) do
+    FeatureGate::GatedFeature.delete_all
+  end
+end

data/spec/support/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ':memory:'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feature_gate
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Tiffany Huang
@@ -38,8 +38,36 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.5'
 description: A gem to toggle feature gates on and off
-email: little.huang@gmail.
+email: little.huang@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -49,13 +77,19 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
-- app/models/gated_feature.rb
+- app/models/feature_gate/gated_feature.rb
+- app/models/feature_gate/manager.rb
 - feature_gate.gemspec
 - lib/feature_gate.rb
 - lib/feature_gate/engine.rb
 - lib/feature_gate/version.rb
 - lib/generators/feature_gate/feature_gate_generator.rb
 - lib/generators/feature_gate/templates/migration.rb
+- spec/factories.rb
+- spec/fake_app.rb
+- spec/models/feature_gate/manager_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.yml
 homepage: https://github.com/tiffling/feature_gate
 licenses:
 - MIT

data/app/models/gated_feature.rb

@@ -1,14 +0,0 @@
-class GatedFeature < ActiveRecord::Base
-  validates :name, presence: true
-  validates :gated, inclusion: { in: [true, false] }
-
-  def deploy_feature!
-    self.gated = false
-    save!
-  end
-
-  def gate_feature!
-    self.gated = true
-    save!
-  end
-end