green_flag 0.1.0

data/app/views/green_flag/admin/features/show.html.erb

@@ -0,0 +1,144 @@
+<div class="header clearfix">
+  <h1><%= link_to 'Green Flag', admin_features_path %> - <%= @feature.code %></h1>
+</div>
+
+<%# Document structure %>
+<div class="row">
+  <div id='rules' class="col-md-12 "></div>
+</div>
+
+<div class="row">
+  <div id='decisions' class="col-md-6 panel "></div>
+  <div id='white-list' class="col-md-6 panel "></div>
+  <div id='your-status' class="col-md-6 panel "></div>
+</div>
+
+<div class="row">
+</div>
+
+
+
+<%# Templates - rules %>
+<script id='rules-template' type='text/html'>
+  <h2>Rules</h2>
+
+  <div class="panel panel-default">
+    <table class="table">
+      <thead>
+        <th>Group Key</th>
+        <th>Group Description</th>
+        <th>Percentage</th>
+        <th></th>
+      </thead>
+      <tbody class="current-rules"></tbody>
+      <tfoot>
+        <th colspan="4" >
+          <div class="input-group">
+            <select class="group-keys form-control">
+              <option disabled>New Rule For...</option>
+            </select>
+            <span class="input-group-btn">
+              <input class="add-rule btn btn-primary" type="button" value="Add Rule" />
+            </span>
+          </div>
+        </th>
+
+      </tfoot>
+    </table>
+
+    <div class="invalid-message panel panel-danger">
+      <div class="panel-heading">These rules cannot be saved.</div>
+      <div class="panel-body">
+        There is probably a good reason.
+        <ul>
+          <li>Percentages should be between 0 and 100</li>
+          <li>Each group can only be included once.</li>
+        </ul>
+      </div>
+    </div>
+
+    <div class="save-buttons panel">
+      <button class="save-rules btn btn-success btn-lg">Save Rules</button>
+      <button class="revert-rules btn btn-default btn-lg">Revert</button>
+    </div>
+  </div>
+</script>
+
+<script id='current-rule-template' type='text/html'>
+  <th>{{group_key}}</th>
+  <td>{{group_description}}</th>
+  <td class="percentage">
+    <input type="number" class="rule-percent" value="{{percentage}}" min="0" max="100" />%
+  </td>
+  <td>
+    <button type="button" class="close remove-rule" aria-hidden="true">&times;</button>
+  </td>
+</script>
+
+<%# Templates - decisions %>
+<script id='decisions-template' type='text/html'>
+  <h2>Decisions Made</h2>
+  <div class="panel panel-default col-md-6">
+
+    <ul class="decisions-made-summary">
+      <li>
+        <span class="decision-number">{{enabled}}</span><br>Enabled
+      </li>
+      <li>
+        <button class="forget-decisions-enabled btn btn-lg">Forget</button>
+      </li>      
+    </ul>
+
+  </div>
+
+  <div class="panel panel-default col-md-6">
+
+    <ul class="decisions-made-summary">
+      <li>
+        <span class="decision-number">{{disabled}}</span><br>Disabled
+      </li>
+      <li>
+        <button class="forget-decisions-disabled btn btn-lg">Forget</button>
+      </li>      
+    </ul>
+
+  </div>
+
+
+</script>
+
+<%# Templates - white list %>
+<script id='white-list-template' type='text/html'>
+  <h2>White List</h2>
+
+  <div class="list-group">
+    <div class='white-list-user-list'></div>
+    <div class="list-group-item">
+      <div class="alert alert-warning error-message" style="display:none">User not found</div>
+      <div class="input-group">
+        <input class="user-email form-control" placeholder="Email" />
+        <span class="input-group-btn">
+          <input class="add-user btn btn-primary" type="button" value="Add User">
+        </span>
+      </div>
+    </div>
+  </div>
+</script>
+
+<script id='white-list-user-template' type='text/html'>
+  <button type="button" class="close destroy-user" aria-hidden="true">&times;</button>
+  <strong>{{name}}</strong> {{email}}
+</script>
+
+<script id='your-status-template' type='text/html'>
+  <h2>Your Status <span class="label {{labelClass}}">{{status}}</span></h2>
+</script>
+
+<%# Javascript kickstart %>
+<%= javascript_include_tag 'green_flag/admin/features' %>
+<script>
+  GreenFlag.FeatureEditor.start({
+    feature: <%= @feature.to_json.html_safe %>,
+    allVisitorGroups: <%= @visitor_groups.to_json.html_safe %>,
+  });
+</script>

data/app/views/layouts/green_flag/application.html.erb

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>GreenFlag</title>
+  <%= stylesheet_link_tag "green_flag/application", :media => "all" %>
+  <%= stylesheet_link_tag '//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css' %>
+  <%= stylesheet_link_tag 'green_flag/admin/features' %>
+
+  <script src="https://code.jquery.com/jquery-1.11.3.min.js"></script>  
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.5.1/underscore-min.js"></script>
+  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>  
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/backbone.js/1.0.0/backbone.js"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/backbone.marionette/1.0.4/backbone.marionette.min.js"></script>
+
+  <%= javascript_include_tag "green_flag/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<div class="container">
+  <%= yield %>
+</div>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,12 @@
+GreenFlag::Engine.routes.draw do
+
+  namespace :admin do
+    resources :features do
+      get 'current_visitor_status', on: :member
+      resources :white_list_users
+      resource :rule_list
+      resource :feature_decision_summary
+    end
+  end
+
+end

data/db/migrate/20140502112602_create_green_flag_site_visitors.rb

@@ -0,0 +1,9 @@
+class CreateGreenFlagSiteVisitors < ActiveRecord::Migration
+  def change
+    create_table :green_flag_site_visitors do |t|
+      t.integer :user_id
+      t.timestamps
+    end
+    add_index :green_flag_site_visitors, :user_id, unique: true
+  end
+end

data/db/migrate/20140502221059_create_green_flag_features.rb

@@ -0,0 +1,10 @@
+class CreateGreenFlagFeatures < ActiveRecord::Migration
+  def change
+    create_table :green_flag_features do |t|
+      t.string :code, null: false
+      t.string :description
+      t.timestamps
+    end
+    add_index :green_flag_features, :code, :unique => true
+  end
+end

data/db/migrate/20140502221423_create_green_flag_feature_decisions.rb

@@ -0,0 +1,13 @@
+class CreateGreenFlagFeatureDecisions < ActiveRecord::Migration
+  def change
+    create_table :green_flag_feature_decisions do |t|
+      t.integer :feature_id, null: false
+      t.integer :site_visitor_id, null: false
+      t.boolean :enabled
+      t.boolean :manual
+      t.timestamps
+    end
+    add_index :green_flag_feature_decisions, [:site_visitor_id, :feature_id], 
+      {unique: true, name: 'index_gf_feature_decisions_on_site_visitor_id_feature_id'}
+  end
+end

data/db/migrate/20140505204611_add_visitor_code_to_site_visitors.rb

@@ -0,0 +1,8 @@
+class AddVisitorCodeToSiteVisitors < ActiveRecord::Migration
+  def change
+    add_column :green_flag_site_visitors, :visitor_code, :string
+    execute 'update green_flag_site_visitors set visitor_code = id'
+    change_column :green_flag_site_visitors, :visitor_code, :string, null: false
+    add_index :green_flag_site_visitors, :visitor_code, unique: true
+  end
+end

data/db/migrate/20140511045110_create_green_flag_rules.rb

@@ -0,0 +1,12 @@
+class CreateGreenFlagRules < ActiveRecord::Migration
+  def change
+    create_table :green_flag_rules do |t|
+      t.string :group_key
+      t.integer :feature_id
+      t.integer :order_by
+      t.integer :percentage
+      t.timestamps
+    end
+    add_index :green_flag_rules, [:feature_id, :order_by]
+  end
+end

data/db/migrate/20140513203728_set_default_percentage_in_green_flag_rules.rb

@@ -0,0 +1,10 @@
+class SetDefaultPercentageInGreenFlagRules < ActiveRecord::Migration
+  def up
+    execute 'update green_flag_rules set percentage=0 where percentage is null'
+    change_column :green_flag_rules, :percentage, :integer, default: 0, null: false
+  end
+
+  def down
+    change_column :green_flag_rules, :percentage, :integer, default: nil, null: true
+  end
+end

data/db/migrate/20140514202337_require_ordering_for_green_flag_rules.rb

@@ -0,0 +1,13 @@
+class RequireOrderingForGreenFlagRules < ActiveRecord::Migration
+  def up
+    change_column :green_flag_rules, :order_by, :integer, null: false
+    remove_index :green_flag_rules, [:feature_id, :order_by]
+    add_index :green_flag_rules, [:feature_id, :order_by], :unique => true
+  end
+
+  def down
+    remove_index :green_flag_rules, [:feature_id, :order_by]
+    add_index :green_flag_rules, [:feature_id, :order_by]
+    change_column :green_flag_rules, :order_by, :integer, null: true
+  end
+end

data/db/migrate/20140516214909_add_restrictions_to_green_flag_rules.rb

@@ -0,0 +1,13 @@
+class AddRestrictionsToGreenFlagRules < ActiveRecord::Migration
+  def up
+    change_column :green_flag_rules, :group_key, :string, null: false
+    change_column :green_flag_rules, :feature_id, :integer, null: false
+    add_index :green_flag_rules, [:feature_id, :group_key], :unique => true
+  end
+
+  def down
+    remove_index :green_flag_rules, [:feature_id, :group_key]
+    change_column :green_flag_rules, :group_key, :string, null: true
+    change_column :green_flag_rules, :feature_id, :integer, null: true
+  end
+end

data/db/migrate/20150211214159_create_green_flag_feature_events.rb

@@ -0,0 +1,13 @@
+class CreateGreenFlagFeatureEvents < ActiveRecord::Migration
+  def change
+    create_table :green_flag_feature_events do |t|
+      t.integer :feature_id, :null => false
+      t.integer :event_type_code, :null => false
+      t.integer :count, :null => false
+      t.timestamps
+    end
+
+    add_index :green_flag_feature_events, :feature_id
+    add_index :green_flag_feature_events, :event_type_code
+  end
+end

data/db/migrate/20150213191101_add_rule_id_to_green_flag_feature_decisions.rb

@@ -0,0 +1,5 @@
+class AddRuleIdToGreenFlagFeatureDecisions < ActiveRecord::Migration
+  def change
+    add_column :green_flag_feature_decisions, :rule_id, :integer
+  end
+end

data/db/migrate/20150218035000_add_version_number_to_green_flag_rules.rb

@@ -0,0 +1,9 @@
+class AddVersionNumberToGreenFlagRules < ActiveRecord::Migration
+  def self.up
+    add_column :green_flag_rules, :version_number, :integer, null: false, default: 1
+  end
+
+  def self.down
+    remove_column :green_flag_rules, :version_number
+  end
+end

data/db/migrate/20150218035805_add_version_number_to_green_flag_features.rb

@@ -0,0 +1,9 @@
+class AddVersionNumberToGreenFlagFeatures < ActiveRecord::Migration
+  def self.up
+    add_column :green_flag_features, :version_number, :integer, null: false, default: 1
+  end
+
+  def self.down
+    remove_column :green_flag_features, :version_number
+  end
+end

data/db/migrate/20150218171852_add_version_number_to_green_flag_rules_indices.rb

@@ -0,0 +1,19 @@
+require 'activerecord-concurrent-index'
+
+class AddVersionNumberToGreenFlagRulesIndices < ActiveRecord::Migration
+  def up
+    remove_index :green_flag_rules, [:feature_id, :group_key]
+    remove_index :green_flag_rules, [:feature_id, :order_by]
+
+    add_index_concurrently :green_flag_rules, [:feature_id, :group_key, :version_number], :unique => true, :name => 'index_green_flag_rules_on_feature_version_and_group_key'
+    add_index_concurrently :green_flag_rules, [:feature_id, :order_by,  :version_number], :unique => true, :name => 'index_green_flag_rules_on_feature_version_and_order_by'
+  end
+
+  def down
+    add_index_concurrently :green_flag_rules, [:feature_id, :group_key], :unique => true
+    add_index_concurrently :green_flag_rules, [:feature_id, :order_by],  :unique => true
+
+    remove_index :green_flag_rules, [:feature_id, :group_key, :version_number]
+    remove_index :green_flag_rules, [:feature_id, :order_by,  :version_number]
+  end
+end

data/green_flag.gemspec

@@ -0,0 +1,34 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "green_flag/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "green_flag"
+  s.version     = GreenFlag::VERSION
+  s.authors     = ["Tim Morton"]
+  s.email       = ["tim@timothymorton.com"]
+  s.homepage    = "https://github.com/websdotcom/green_flag"
+  s.summary     = "A feature-flag system."
+  s.description = <<-EOF
+    A feature-flag system that makes it *really easy* for application developers
+    to add and manage features.  You can roll out features to a percentage of 
+    your users, or you can define groups to see the new feature.  
+    Want to test a new feature on 50% of your premium-plan users named "Fred"?  
+    GreenFlag can do that.
+  EOF
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split($/)
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_dependency "rails", "~> 3.2"
+  s.add_dependency "pg", "~> 0.18"
+  s.add_dependency "activerecord-concurrent-index", "~> 0.0.1"
+  s.add_dependency "sass-rails", "~> 3.2"
+
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'factory_girl_rails'
+  s.add_development_dependency 'capybara'
+end

data/lib/green_flag/engine.rb

@@ -0,0 +1,16 @@
+module GreenFlag
+  class Engine < ::Rails::Engine
+    isolate_namespace GreenFlag
+
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+    initializer "green_flag.site_visitor_management" do |app|
+      ActionController::Base.send :include, GreenFlag::SiteVisitorManagement
+    end
+  end
+end

data/lib/green_flag/version.rb

@@ -0,0 +1,3 @@
+module GreenFlag
+  VERSION = "0.1.0"
+end

data/lib/green_flag.rb

@@ -0,0 +1,4 @@
+require "green_flag/engine"
+
+module GreenFlag
+end

data/lib/tasks/green_flag_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :green_flag do
+#   # Task goes here
+# end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/green_flag/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/controllers/admin/feature_decision_summaries_controller_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe GreenFlag::Admin::FeatureDecisionSummariesController do
+
+  let(:feature) { GreenFlag::Feature.create(code: 'asdf') }
+
+  describe '#show' do
+    subject { get :show, feature_id: feature.id, format: 'js' }
+    it { should be_successful }
+  end
+
+  describe '#update' do
+    subject { post :update, feature_id: feature.id, format: 'js' }
+    it { should be_successful }
+  end
+
+end

data/spec/controllers/admin/features_controller_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe GreenFlag::Admin::FeaturesController do
+
+  let(:feature) { GreenFlag::Feature.create(code: 'foo') }
+
+  describe '#index' do
+    it 'is successful' do
+      get :index
+      expect(response).to be_success
+    end
+  end  
+
+  describe '#show' do
+    it 'is successful' do
+      get :show, :id => feature.id
+      expect(response).to be_success
+    end
+  end  
+
+end

data/spec/controllers/admin/rule_lists_controller_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe GreenFlag::Admin::RuleListsController do
+
+  let(:feature) { GreenFlag::Feature.create(code: 'asdf') }
+
+  describe '#show' do
+    subject { get :show, feature_id: feature.id, format: 'js' }
+    it { should be_successful }
+  end
+
+  describe '#update' do
+    let(:empty_rules_json) { [] }
+    subject do 
+      post :update, feature_id: feature.id, format: 'js',
+        '_json' =>  empty_rules_json
+    end
+    it { should be_successful }
+    it 'sends the rules to a model' do
+      expect(GreenFlag::Rule).to receive(:set_rules!).with(feature.id, [])
+      subject
+    end
+  end
+
+end

data/spec/controllers/admin/white_list_users_controller_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe GreenFlag::Admin::WhiteListUsersController do
+
+  describe '#index' do
+    subject { get :index, feature_id: 1, format: 'js' }
+    context 'with no whitelisted users' do
+      before(:each) do
+        allow(GreenFlag::FeatureDecision).to receive(:whitelisted_users) { [] }
+      end
+      it { should be_successful }
+    end
+  end
+
+end

data/spec/controllers/site_visitor_management_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe GreenFlag::SiteVisitorManagement do
+
+  controller(ActionController::Base) do
+    include GreenFlag::SiteVisitorManagement
+
+    def index
+      render :text => 'foo'
+    end
+
+    def current_user
+      nil
+    end
+  end
+
+  let(:cookie_name) { GreenFlag::SiteVisitorManagement::COOKIE_NAME }
+
+  it 'does not prevent the controller from rendering' do
+    get :index
+    expect(response).to be_success
+  end
+
+  context '#set_site_visitor' do
+    context 'when there is no vistor cookie' do
+      it 'does not create a new visitor' do
+        expect{ get :index }.to_not change { GreenFlag::SiteVisitor.count }
+      end
+
+      it 'sets the visitor cookie' do
+        get :index
+        expect(response.cookies[cookie_name]).to be_present
+      end
+    end
+
+    context 'when there is a visitor cookie' do
+      before(:each) do
+        request.cookies[cookie_name] = '2d931510-d99f-494a-8c67-87feb05e1594'
+      end
+
+      it 'does not create a new visitor' do
+        expect{ get :index }.to_not change { GreenFlag::SiteVisitor.count }
+      end
+      it 'calls record_login when there is a current_user' do
+        user = double
+        controller.stub(:current_user) { user }
+        expect(controller).to receive(:record_login).with(user)
+        get :index
+      end
+    end
+  end
+
+
+end