green_flag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f72b8a42b9157e77de05c33652f3ae98ac042e8
+  data.tar.gz: 0c9627482a3ed2400c921e407dd1b2e1ddf19e87
+SHA512:
+  metadata.gz: 13d73c704f26582f0211687ae0d341577cfcf6efd9ff9153d633b931b2c9071399611705df196ef95b5ab20a2fee5e3e99009ff8fc3a40a4ac71149fc6c1fe98
+  data.tar.gz: 9e7593b849c503674f6520d9d55e89913afb4a3bfc9cee3b80689376aaccbbbb1315a96f7caa9935a252a3e9f59159b86c84579783f67db9e5005c686e88c57d

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in green_flag.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: .
+  specs:
+    green_flag (0.1.0)
+      activerecord-concurrent-index (~> 0.0.1)
+      pg (~> 0.18)
+      rails (~> 3.2)
+      sass-rails (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.22)
+      actionpack (= 3.2.22)
+      mail (~> 2.5.4)
+    actionpack (3.2.22)
+      activemodel (= 3.2.22)
+      activesupport (= 3.2.22)
+      builder (~> 3.0.0)
+      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)
+      activesupport (= 3.2.22)
+      builder (~> 3.0.0)
+    activerecord (3.2.22)
+      activemodel (= 3.2.22)
+      activesupport (= 3.2.22)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activerecord-concurrent-index (0.0.1)
+      activerecord
+    activeresource (3.2.22)
+      activemodel (= 3.2.22)
+      activesupport (= 3.2.22)
+    activesupport (3.2.22)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    factory_girl (4.1.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.1.0)
+      factory_girl (~> 4.1.0)
+      railties (>= 3.0.0)
+    hike (1.2.3)
+    i18n (0.7.0)
+    journey (1.0.4)
+    jquery-rails (3.1.3)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.3)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    pg (0.18.2)
+    polyglot (0.3.5)
+    rack (1.4.7)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (3.2.22)
+      actionmailer (= 3.2.22)
+      actionpack (= 3.2.22)
+      activerecord (= 3.2.22)
+      activeresource (= 3.2.22)
+      activesupport (= 3.2.22)
+      bundler (~> 1.0)
+      railties (= 3.2.22)
+    railties (3.2.22)
+      actionpack (= 3.2.22)
+      activesupport (= 3.2.22)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    rspec-rails (2.14.2)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    sass (3.4.14)
+    sass-rails (3.2.6)
+      railties (~> 3.2.0)
+      sass (>= 3.1.10)
+      tilt (~> 1.3)
+    sprockets (2.2.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.19.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.44)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  factory_girl_rails
+  green_flag!
+  jquery-rails
+  rspec-rails

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014-2015 Webs, Inc.
+
+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,43 @@
+# ![Green Flag Logo](./green_flag_small.png?raw=true) Green Flag
+
+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.
+
+Status: Recently extracted from a running application.  Version 0.1 is just enough for us to use it as a gem.  Some of the niceties (like this document) are pretty rough. 
+
+## New feature?  Just do this:
+
+In a controller or view, check for a feature:
+```ruby
+if feature_enabled?(:my_awesome_feature)
+  # New hotness
+else
+  # Old stuff
+end
+```
+
+That's it. You don't have to create a feature record (it's done automatically).  
+You don't have to figure out who should see the feature - that's set up in the admin web interface.
+
+Features are off by default - so if you deploy your new code, no one will get the new hotness until you open it up with the admin web interface.  
+
+## How it works
+
+TODO: explain about visitors, users and features.
+
+## Installation
+
+### Requirements
+- Rails 3
+- Postgres
+- `User` class, and `current_user` controller method
+
+TODO: Some of this should be scripted with a generator
+- Normal engine install process
+- Install/run migrations
+- Create an initializer to define visitor groups
+- Mount admin in routes.rb
+
+## Admin panel
+
+TODO: explain all of the stuff on the admin panel
+

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GreenFlag'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/javascripts/green_flag/admin/features.js

@@ -0,0 +1,353 @@
+_.templateSettings = {
+  evaluate : /\{\[([\s\S]+?)\]\}/g,
+  interpolate : /\{\{([\s\S]+?)\}\}/g
+};
+
+
+// NAMESPACE ------------------------------------------------------------------
+var GreenFlag = GreenFlag || {};
+
+// APPLICATION ----------------------------------------------------------------
+GreenFlag.FeatureEditor = new Backbone.Marionette.Application();
+
+GreenFlag.FeatureEditor.addRegions({
+  whiteList: '#white-list',
+  rules: '#rules',
+  yourStatus: '#your-status',
+  decisions: '#decisions',
+});
+
+GreenFlag.FeatureEditor.addInitializer(function(options){
+  new GreenFlag.PostImageController(options);
+});
+
+// CONTROLLER ----------------------------------------------------------------
+GreenFlag.PostImageController = Backbone.Marionette.Controller.extend({
+  initialize: function(options) {
+    this.feature = options.feature;
+    this.setupRules(this.feature, options.allVisitorGroups);
+    this.setupWhiteList(this.feature);
+    this.setupYourStatus(this.feature);
+    this.setupDecisions(this.feature);    
+  },
+
+  setupRules: function(feature, allVisitorGroups) {
+    var ruleList = new GreenFlag.RuleList([], {
+      feature: feature,
+    });
+    window.ruleList = ruleList;
+    var rulesView = new GreenFlag.RulesView({
+       collection: ruleList,
+       allVisitorGroups: allVisitorGroups,
+    });
+    GreenFlag.FeatureEditor.rules.show(rulesView);
+    ruleList.fetch();
+  },
+
+  setupWhiteList: function(feature) {
+    var whiteList = new GreenFlag.WhiteList([], {
+      feature: feature,
+    });
+    var whiteListView = new GreenFlag.WhiteListView({
+      collection: whiteList,
+    });
+    GreenFlag.FeatureEditor.whiteList.show(whiteListView);
+    whiteList.fetch();
+  },
+
+  setupYourStatus: function(feature) {
+    var status = new GreenFlag.YourStatus({
+      feature: feature,
+    });
+    var yourStatusView = new GreenFlag.YourStatusView({
+      model: status
+    });
+    GreenFlag.FeatureEditor.yourStatus.show(yourStatusView);
+    status.fetch();
+  },
+
+  setupDecisions: function(feature) {
+    var decisionSummary = new GreenFlag.DecisionSummary({
+      feature: feature,
+      enabled: 0,
+      disabled: 0,
+    })
+    var decisionsView = new GreenFlag.DecisionsView({
+      model: decisionSummary,
+    });
+    GreenFlag.FeatureEditor.decisions.show(decisionsView);
+    decisionSummary.fetch();
+  },
+});
+
+// MODELS ----------------------------------------------------------------
+GreenFlag.WhiteList = Backbone.Collection.extend({
+  url: function() {
+    return '/green_flag/admin/features/'+this.feature.id+'/white_list_users';
+  },
+
+  initialize: function(models, options) {
+    this.feature = options.feature;
+  },
+});
+
+GreenFlag.RuleList = Backbone.Collection.extend({
+
+  url: function() {
+    return '/green_flag/admin/features/'+this.feature.id+'/rule_list';
+  },
+
+  initialize: function(models, options) {
+    this.feature = options.feature;
+
+    this.isDirty = false;
+    this.on('change add remove sort', this.setDirty, this);
+    this.on('sync', this.setClean, this);
+  },
+
+  saveRules: function() {
+    Backbone.sync('update', this, {
+      success: this.setClean,
+      error: this.setInvalid,
+      context: this,
+    });
+  },
+
+  setDirty: function() {
+    this._setDirtyState(true);
+  },
+
+  setClean: function() {
+    if(this.isInvalid) {
+      this.isInvalid = false;
+      this.trigger('change:isInvalid');
+    }
+    this._setDirtyState(false);
+  },
+
+  setInvalid: function() {
+    if(!this.isInvalid) {
+      this.isInvalid = true;
+      this.trigger('change:isInvalid');
+    }
+  },
+
+  _setDirtyState: function(newIsDirty) {
+    newIsDirty = !!newIsDirty;
+    if(newIsDirty !== this.isDirty) {
+      this.isDirty = newIsDirty;
+      this.trigger('change:isDirty');
+    }
+  },
+
+  sortBy: function(rule) {
+    return rule.get('order_by');
+  },
+
+  nextOrderBy: function() {
+    if(this.isEmpty()) {
+      return 0;
+    }
+    var maxOrder = this.last().get('order_by');
+    maxOrder = parseInt(maxOrder, 10);
+    return maxOrder + 1;
+  }
+});
+
+GreenFlag.YourStatus = Backbone.Model.extend({
+  url: function() {
+    return '/green_flag/admin/features/'+this.feature.id+'/current_visitor_status';
+  },
+
+  initialize: function(attributes, options) {
+    this.feature = attributes.feature;
+  },
+});
+
+GreenFlag.DecisionSummary = Backbone.Model.extend({
+  url: function() {
+    return '/green_flag/admin/features/'+this.feature.id+'/feature_decision_summary';
+  },
+
+  initialize: function(attributes, options) {
+    this.feature = attributes.feature;
+  },
+
+  isNew: function() { return false; }
+});
+
+// VIEWS ----------------------------------------------------------------
+GreenFlag.WhiteListUserView = Backbone.Marionette.ItemView.extend({
+  template: '#white-list-user-template',
+  className: 'list-group-item',
+  events: {
+    'click .destroy-user': 'destroyUser'
+  },
+
+  destroyUser: function() {
+    this.model.destroy({wait: true});
+  }
+});
+
+GreenFlag.WhiteListView = Backbone.Marionette.CompositeView.extend({
+  template: "#white-list-template",
+  itemView: GreenFlag.WhiteListUserView,
+  itemViewContainer: '.white-list-user-list',
+
+  events: {
+    'click .add-user': 'addUser',
+    'keypress .user-email': 'checkForEnter',
+  },
+
+  addUser: function() {
+    var email = this.$('.user-email').val();
+    this.collection.create({ email: email }, { 
+      wait: true,
+      success: this.clearForm,
+      error: this.errorMessage
+    });
+  },
+
+  checkForEnter: function(e) {
+    if(e.keyCode === 13) {
+      this.addUser();
+    }
+  },
+
+  clearForm: function() {
+    this.$('.user-email').val('');
+    this.$('.error-message').hide();
+    this.$('.user-email').focus();
+  },
+  errorMessage: function() {
+    this.$('.error-message').show();
+    this.$('.user-email').focus();
+  }
+});
+
+GreenFlag.CurrentRuleView = Backbone.Marionette.ItemView.extend({
+  template: '#current-rule-template',
+  tagName: 'tr',
+
+  events: {
+    'change .rule-percent': 'setPercent',
+    'keypress .rule-percent': 'setPercent',
+    'click .remove-rule': 'removeRule',
+  },
+
+  setPercent: function() {
+    var pct = this.$('.rule-percent').val();
+    this.model.set({percentage: pct});
+  },
+
+  removeRule: function() {
+    this.model.collection.remove(this.model);
+  },
+});
+
+GreenFlag.RulesView = Backbone.Marionette.CompositeView.extend({
+  template: '#rules-template',
+  itemView: GreenFlag.CurrentRuleView,
+  itemViewContainer: '.current-rules',
+
+  events: {
+    'click .add-rule': 'addRule',
+    'click .save-rules': 'saveRules',
+    'click .revert-rules': 'revertRules',
+  },
+
+  initialize: function(options) {
+    this.allVisitorGroups = options.allVisitorGroups || [];
+    this.listenTo(this.collection, 'change:isDirty', this.setSaveButtons, this);
+    this.listenTo(this.collection, 'change:isInvalid', this.setInvalidMessage, this);
+    this.listenTo(this.collection, 'sync', this.render);
+  },
+
+  saveRules: function() {
+    this.collection.saveRules();
+  },
+
+  revertRules: function() {
+    this.collection.fetch();
+  },
+
+  addRule: function() {
+    var groupIndex = this.$('select.group-keys').val();
+    var group = this.allVisitorGroups[groupIndex];
+    this.collection.add({
+      group_key: group.key, 
+      group_description: group.description, 
+      percentage: 0,
+      order_by: this.collection.nextOrderBy(),
+    });
+  },
+
+  setSaveButtons: function() {
+    if(this.collection.isDirty) {
+      this.$('.save-buttons').show(300);
+    } else {
+      this.$('.save-buttons').hide();
+    }
+  },
+
+  setInvalidMessage: function() {
+    if(this.collection.isInvalid) {
+      this.$('.invalid-message').show(300);
+    } else {
+      this.$('.invalid-message').hide();
+    }
+  },
+
+  onRender: function() {
+    var selectEl = this.$('select.group-keys');
+    _.each(this.allVisitorGroups, function(group, i) {
+      var key = group.key;
+      selectEl.append("<option value=\""+i+"\">"+key+"</option>")
+    });
+    this.setSaveButtons();
+    this.setInvalidMessage();
+  }
+});
+
+GreenFlag.YourStatusView = Backbone.Marionette.ItemView.extend({
+  template: '#your-status-template',
+  modelEvents: {
+    'change': 'render',
+  },
+
+  serializeData: function() {
+    return _.extend({ labelClass: this.labelClass() }, this.model.toJSON());
+  },
+
+  labelClass: function() {
+    var status = this.model.get('status');
+    var label = 'label-default';
+    if(status === 'Enabled') {
+      label = 'label-success';
+    } else if(status === 'Disabled') {
+      label = 'label-warning';
+    }
+
+    return label;
+  },
+});
+
+GreenFlag.DecisionsView = Backbone.Marionette.ItemView.extend({
+  template: '#decisions-template',
+  modelEvents: {
+    'change': 'render',
+  },
+  events: {
+    'click .forget-decisions-enabled': 'forgetDecisionsEnabled',
+    'click .forget-decisions-disabled': 'forgetDecisionsDisabled',    
+  },
+
+  forgetDecisionsEnabled: function() {
+    this.model.save({ forget_enabled: true });
+  },
+
+  forgetDecisionsDisabled: function() {
+    this.model.save({ forget_disabled: true });
+  },
+
+});

data/app/assets/javascripts/green_flag/admin/rules.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/green_flag/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/green_flag/admin/features.css.scss

@@ -0,0 +1,36 @@
+// Place all the styles related to the green_flag/admin/features controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/
+
+@media (min-width: 768px) {
+  .container {
+    max-width: 768px;
+  }
+}
+
+.header {
+  border-bottom: 1px solid #e5e5e5;
+}
+
+.percentage {
+  white-space: nowrap;
+}
+
+ul.decisions-made-summary {
+  
+  padding: 0;
+  margin: 10px;
+
+  li {
+    display: inline-block;
+    list-style-type: none;
+    width: 45%;
+    text-align: center;
+    vertical-align: middle;
+  }
+
+  .decision-number {
+    font-weight: 500;
+    font-size: 24px;
+  }
+}

data/app/assets/stylesheets/green_flag/admin/rules.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the green_flag/admin/rules controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/