detour 0.0.3 → 0.0.5

data/app/models/detour/membership.rb

@@ -0,0 +1,41 @@
+class Detour::Membership < ActiveRecord::Base
+  validates :group_id,    presence: true
+  validates :member_id,   presence: true, uniqueness: { scope: :group_id }
+  validates :member_key,  presence: true, unless: -> { member_id }
+  validates :member_type, presence: true
+  validate  :validate_member_type
+
+  attr_accessor   :member_key
+  attr_accessible :group_id
+  attr_accessible :member_key
+  attr_accessible :member_type
+
+  default_scope { order("member_type ASC") }
+
+  belongs_to :group
+  belongs_to :member, polymorphic: true
+
+  before_validation :set_member
+
+  private
+
+  def member_class
+    group.flaggable_class
+  end
+
+  def set_member
+    unless member || !member_key
+      self.member_type = group.flaggable_type
+      self.member_id   = member_class.flaggable_find!(member_key).id
+    end
+  rescue ActiveRecord::RecordNotFound
+    errors.add(member_type, "\"#{member_key}\" could not be found")
+    false
+  end
+
+  def validate_member_type
+    unless group && member_type == group.flaggable_type
+      errors.add :member_type, "must match the group's flaggable_type"
+    end
+  end
+end

data/app/models/detour/opt_out_flag.rb

@@ -1,12 +1,5 @@
 # Ensures that a feature will never be available to the associated record,
 # even in the case of, for example, a 100% flag.
-class Detour::OptOutFlag < Detour::Flag
-  include Detour::Concerns::CountableFlag
-
-  belongs_to :flaggable, polymorphic: true
-
-  validates_presence_of   :flaggable
+class Detour::OptOutFlag < Detour::FlaggableFlag
   validates_uniqueness_of :feature_id, scope: [:flaggable_type, :flaggable_id]
-
-  attr_accessible :flaggable
 end

data/app/views/detour/flaggable_flags/_flaggable_flag_fields.html.erb

@@ -0,0 +1,19 @@
+<hr>
+
+<div class="row">
+  <%= f.label :flaggable_key, flaggable_type, class: "col-sm-1" %>
+
+  <div class="col-sm-3">
+    <% if f.object.persisted? %>
+      <%= text_field_tag "flaggable_identifier", f.object.flaggable.send(f.object.flaggable.class.detour_flaggable_find_by), class: "form-control", disabled: "disabled" %>
+    <% else %>
+      <%= f.text_field :flaggable_key, class: "form-control" %>
+    <% end %>
+  </div>
+
+  <div class="col-sm-2 checkbox">
+    <%= f.label :_destroy do %>
+      <%= f.check_box "_destroy" %> Remove <%= flag_noun.capitalize %>
+    <% end %>
+  </div>
+</div>

data/app/views/detour/flaggable_flags/index.html.erb

@@ -1,34 +1,21 @@
 <h1><%= flaggable_type.capitalize %> <%= flag_verb %> <%= feature_name %></h1>
 
-<%= table do %>
-  <thead>
-    <tr>
-      <th></th>
-      <th><%= flaggable_class.detour_flaggable_find_by %></th>
-    </tr>
-  </thead>
-
-  <%= render partial: "flaggable_flag", collection: @flags, as: :flag %>
+<% if @feature.errors.any? %>
+  <ul>
+    <% @feature.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+  </ul>
 <% end %>
 
-<%= content_tag :span, "Create #{flag_title.indefinitize}", class: "btn btn-default pull-left", data: { toggle: "modal", target: "#create-flaggable-flag" } %>
-
-<%= modal title: "Create #{flag_title.indefinitize}", id: "create-flaggable-flag", fade: true do %>
-  <%= form_tag request.path, remote: true do |form| %>
-    <%= text_field_tag :ids, "", class: "form-control" %>
-
-    <%= modal_footer do %>
-      <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
-      <%= submit_tag "Create #{flag_title}", class: "btn btn-default btn-primary" %>
-    <% end %>
+<%= form_for @feature, url: request.path do |form| %>
+  <%= form.fields_for "#{flaggable_type}_#{flag_type.pluralize}" do |flaggable_flag_form| %>
+    <%= render "flaggable_flag_fields", f: flaggable_flag_form %>
   <% end %>
-<% end %>
 
-<%= modal title: "Delete #{flag_title}", id: "delete-flag" do %>
-  <p>Are you sure you want to delete <%= feature_name %> <%= flag_type.dasherize %> for <%= flaggable_class %> <span class="flaggable-identifier"></span>?</p>
+  <%= link_to_add_fields "Add #{flag_noun.capitalize}", form, "#{flaggable_type}_#{flag_type.pluralize}", :flaggable_flag_fields %>
 
-  <%= modal_footer do %>
-    <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
-    <%= link_to "Delete #{flag_title}", "javascript:void(0)", method: :delete, class: "btn btn-danger" %>
-  <% end %>
+  <hr>
+
+  <%= form.submit "Update #{flag_noun.capitalize.pluralize}", class: "btn btn-primary pull-left" %>
 <% end %>

data/app/views/detour/flags/_feature_form.html.erb

@@ -10,12 +10,21 @@
 
     <td><%= feature %></td>
 
+    <td>
+      <% if feature.lines.any? %>
+        <i class="feature-lines glyphicon glyphicon-ok" data-prefix="<%= github_prefix %>" data-lines="<%= feature.lines.join(",") %>"></i>
+        (<%= pluralize(feature.lines.count, "use") %>)
+      <% else %>
+        <i class="glyphicon glyphicon-ban-circle"></i>
+      <% end %>
+    </td>
+
     <%= render partial: "detour/shared/spacer_cells", locals: { tag: "td" } %>
 
-    <% @flag_form.group_flags_for(feature).each do |group_flag| %>
-      <%= feature_form.fields_for "#{params[:flaggable_type]}_group_flags_attributes[#{group_flag.group_name}]", group_flag do |group_flag_form| %>
+    <% @flag_form.group_flags_for(feature).each do |flag| %>
+      <%= feature_form.fields_for "#{params[:flaggable_type]}_#{flag.group_type}_group_flags_attributes[#{flag.group_name}]", flag do |group_flag_form| %>
         <%= group_flag_form.hidden_field :id %>
-        <td><%= group_flag_form.check_box :to_keep, data: { toggle: "tooltip", placement: "top", original_title: "#{group_flag.group_name}" } %></td>
+        <td><%= group_flag_form.check_box :to_keep, data: { toggle: "tooltip", placement: "top", original_title: "#{flag.group_name}" } %></td>
       <% end %>
     <% end %>
 

data/app/views/detour/flags/index.html.erb

@@ -22,13 +22,18 @@
       <tr>
         <th></th>
         <th>Feature</th>
+        <th>In Code?</th>
 
         <%= render partial: "detour/shared/spacer_cells", locals: { tag: "th" } %>
 
-        <% @flag_form.group_names.each do |group_name| %>
+        <% @flag_form.groups.each do |group| %>
           <th>
             <span class="group-header">
-              <%= group_name %>
+              <% if group.is_a? Detour::Group %>
+                <%= link_to group, group %>
+              <% else %>
+                <%= group %>
+              <% end %>
             </span>
           </th>
         <% end %>

data/app/views/detour/groups/_group.html.erb

@@ -0,0 +1,3 @@
+<%= content_tag_for :li, group do %>
+  <%= link_to group, group %>
+<% end %>

data/app/views/detour/groups/_membership_fields.html.erb

@@ -0,0 +1,19 @@
+<hr>
+
+<div class="row">
+  <%= f.label :member_key, @group.flaggable_type.constantize.detour_flaggable_find_by.to_s.titleize, class: "col-sm-1" %>
+
+  <div class="col-sm-3">
+    <% if f.object.persisted? %>
+      <%= text_field_tag "member_identifier", f.object.member.send(f.object.member.class.detour_flaggable_find_by), class: "form-control", disabled: "disabled" %>
+    <% else %>
+      <%= f.text_field :member_key, class: "form-control" %>
+    <% end %>
+  </div>
+
+  <div class="col-sm-2 checkbox">
+    <%= f.label :_destroy do %>
+      <%= f.check_box "_destroy" %> Remove member
+    <% end %>
+  </div>
+</div>

data/app/views/detour/groups/index.html.erb

@@ -0,0 +1,21 @@
+<% Detour.config.flaggable_types.each do |type| %>
+  <h1><%= type %> Groups</h1>
+
+  <%= content_tag :ul, class: "groups" do %>
+    <%= render @groups.select { |group| group.flaggable_type == type } %>
+  <% end %>
+<% end %>
+
+<%= content_tag :span, "Create a Group", class: "btn btn-default", data: { toggle: "modal", target: "#create-group" } %>
+
+<%= modal title: "Create a Group", id: "create-group", fade: true do %>
+  <%= form_for Detour::Group.new, remote: true do |form| %>
+    <%= form.text_field :name, class: "form-control", placeholder: "Group Name" %>
+    <%= form.select :flaggable_type, Detour.config.flaggable_types, class: "form-control" %>
+
+    <%= modal_footer do %>
+      <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
+      <%= form.submit "Create Group", class: "btn btn-primary" %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/detour/groups/show.html.erb

@@ -0,0 +1,41 @@
+<h1><%= @group %></h1>
+
+<% if @group.errors.any? %>
+  <ul>
+    <% @group.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+  </ul>
+<% end %>
+
+<%= form_for @group do |form| %>
+  <div class="row">
+    <%= form.label :name, class: "control-label col-sm-1" %>
+
+    <div class="col-sm-3">
+      <%= form.text_field :name, class: "form-control" %>
+    </div>
+  </div>
+
+  <%= form.fields_for :memberships do |membership_form| %>
+    <%= render "membership_fields", f: membership_form %>
+  <% end %>
+
+  <%= link_to_add_fields "Add Member", form, :memberships %>
+
+
+  <hr>
+
+  <%= form.submit class: "btn btn-primary pull-left" %>
+<% end %>
+
+<%= button_to "Delete Group", group_path(@group), class: "btn btn-danger delete-group", method: :delete %>
+
+<%= modal title: "Delete Group", id: "delete-group" do %>
+  <p>Are you sure you want to delete <%= @group.name %>?</p>
+
+  <%= modal_footer do %>
+    <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
+    <%= link_to "Delete Group", group_path(@group), method: :delete, class: "btn btn-danger" %>
+  <% end %>
+<% end %>

data/app/views/detour/memberships/_membership.html.erb

@@ -0,0 +1,4 @@
+<%= content_tag_for :tr, membership do %>
+  <td><%= membership.member.class %></td>
+  <td><%= membership.member.send membership.member.class.detour_flaggable_find_by %></td>
+<% end %>

data/app/views/detour/{features → shared}/_errors.html.erb

@@ -1,9 +1,9 @@
 <div class="panel panel-danger">
-  <div class="panel-heading">Whoops! There were some errors saving your feature:</div>
+  <div class="panel-heading">Whoops! There were some errors saving your <%= model.class.model_name.singular %>:</div>
 
   <div class="panel-body">
     <ul>
-      <% @feature.errors.full_messages.each do |msg| %>
+      <% model.errors.full_messages.each do |msg| %>
         <li><%= msg %></li>
       <% end %>
     </ul>

data/app/views/detour/shared/_nav.html.erb

@@ -13,6 +13,7 @@
 
     <div class="collapse navbar-collapse navbar-right" id="feature-flags-nav">
       <ul class="nav navbar-nav">
+        <li><%= link_to "Groups", groups_path %></li>
         <li class="dropdown">
           <a href="javascript:void(0)" data-toggle="dropdown">Feature Flags <b class="caret"></b></a>
 

data/app/views/detour/shared/error.js.erb

@@ -0,0 +1,5 @@
+if ($(".modal-body:visible .panel-danger").length) {
+  $(".modal-body:visible .panel-danger").replaceWith("<%= j render partial: "detour/shared/errors", locals: { model: @model } %>");
+} else {
+  $(".modal-body:visible").prepend("<%= j render partial: "detour/shared/errors", locals: { model: @model } %>");
+}

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  activerecord:
+    errors:
+      models:
+        detour/feature:
+          attributes:
+              name:
+                invalid: "must be composed of letters, numbers, underscores, and dashes"

data/config/routes.rb

@@ -3,14 +3,15 @@ Detour::Engine.routes.draw do
   post "/flags/:flaggable_type" => "flags#update"
 
   resources :features, only: [:create, :destroy]
+  resources :groups, only: [:index, :show, :create, :update, :destroy]
 
-  get    "/flag-ins/:feature_name/:flaggable_type"     => "flaggable_flags#index",   as: "flag_in_flags"
-  post   "/flag-ins/:feature_name/:flaggable_type"     => "flaggable_flags#create"
-  delete "/flag-ins/:feature_name/:flaggable_type/:id" => "flaggable_flags#destroy", as: "flag_in_flag"
-
-  get    "/opt-outs/:feature_name/:flaggable_type"     => "flaggable_flags#index",   as: "opt_out_flags"
-  post   "/opt-outs/:feature_name/:flaggable_type"     => "flaggable_flags#create"
-  delete "/opt-outs/:feature_name/:flaggable_type/:id" => "flaggable_flags#destroy", as: "opt_out_flag"
+  %w[flag-ins opt-outs].each do |flag_type|
+    scope "/#{flag_type}/:feature_name" do
+      get    ":flaggable_type"     => "flaggable_flags#index",   as: "#{flag_type.underscore.singularize}_flags"
+      put    ":flaggable_type"     => "flaggable_flags#update"
+      delete ":flaggable_type/:id" => "flaggable_flags#destroy", as: "#{flag_type.underscore.singularize}_flag"
+    end
+  end
 
   root to: "application#index"
 end

data/detour.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "capybara"
   spec.add_development_dependency "database_cleaner", "~> 1.2.0"
   spec.add_development_dependency "factory_girl_rails"
+  spec.add_development_dependency "launchy"
   spec.add_development_dependency "poltergeist"
   spec.add_development_dependency "pry-nav"
   spec.add_development_dependency "rspec-rails"

data/lib/detour/acts_as_flaggable.rb

@@ -23,14 +23,23 @@ module Detour::ActsAsFlaggable
         update_only: true,
         reject_if: proc { |attrs| attrs[:percentage].blank? }
 
-      has_many :#{table_name}_group_flags,
-        class_name: "Detour::GroupFlag",
+      has_many :#{table_name}_defined_group_flags,
+        class_name: "Detour::DefinedGroupFlag",
         inverse_of: :feature,
         dependent: :destroy,
         conditions: { flaggable_type: "#{self}" }
 
-      attr_accessible :#{table_name}_group_flags_attributes
-      accepts_nested_attributes_for :#{table_name}_group_flags, allow_destroy: true
+      attr_accessible :#{table_name}_defined_group_flags_attributes
+      accepts_nested_attributes_for :#{table_name}_defined_group_flags, allow_destroy: true
+
+      has_many :#{table_name}_database_group_flags,
+        class_name: "Detour::DatabaseGroupFlag",
+        inverse_of: :feature,
+        dependent: :destroy,
+        conditions: { flaggable_type: "#{self}" }
+
+      attr_accessible :#{table_name}_database_group_flags_attributes
+      accepts_nested_attributes_for :#{table_name}_database_group_flags, allow_destroy: true
 
       has_many :#{table_name}_flag_ins,
         class_name: "Detour::FlagInFlag",
@@ -38,11 +47,17 @@ module Detour::ActsAsFlaggable
         dependent:  :destroy,
         conditions: { flaggable_type: "#{self}" }
 
+      attr_accessible :#{table_name}_flag_ins_attributes
+      accepts_nested_attributes_for :#{table_name}_flag_ins, allow_destroy: true
+
       has_many :#{table_name}_opt_outs,
         class_name: "Detour::OptOutFlag",
         inverse_of: :feature,
         dependent:  :destroy,
         conditions: { flaggable_type: "#{self}" }
+
+      attr_accessible :#{table_name}_opt_outs_attributes
+      accepts_nested_attributes_for :#{table_name}_opt_outs, allow_destroy: true
     EOF
 
     class_eval do

data/lib/detour/configuration.rb

@@ -30,6 +30,6 @@ class Detour::Configuration
 
   def define_group_for_class(klass, group_name, &block)
     @defined_groups[klass] ||= {}
-    @defined_groups[klass][group_name] = block
+    @defined_groups[klass][group_name] = Detour::DefinedGroup.new(group_name, block)
   end
 end

data/lib/detour/flag_form.rb

@@ -1,28 +1,25 @@
 class Detour::FlagForm
   def initialize(flaggable_type)
-    @flaggable_type = flaggable_type
+    @flaggable_type = flaggable_type.classify.constantize
   end
 
   def features
-    @features ||= Detour::Feature.includes("#{@flaggable_type}_percentage_flag", "#{@flaggable_type}_group_flags").with_lines
+    @features ||= Detour::Feature.includes("#{flaggable_collection}_percentage_flag", "#{flaggable_collection}_database_group_flags", "#{flaggable_collection}_defined_group_flags").with_lines
   end
 
   def errors?
     features.any? { |feature| feature.errors.any? }
   end
 
-  def group_names
-    @group_names ||= begin
-      all_names = features.collect { |feature| feature.send("#{@flaggable_type}_group_flags").collect(&:group_name) }.uniq.flatten
-      defined_group_names = Detour.config.defined_groups.fetch(@flaggable_type.classify, {}).keys.map(&:to_s)
-      (all_names | defined_group_names).sort
-    end
+  def groups
+    @groups ||= (database_groups + defined_groups).sort_by { |group| group.name.downcase }
   end
 
-  def group_flags_for(feature, initialize = true)
-    group_names.map do |group_name|
-      flags = feature.send("#{@flaggable_type}_group_flags")
-      flags.detect { |flag| flag.group_name == group_name } || (flags.new(group_name: group_name) if initialize)
+  def group_flags_for(feature, types = %w[defined database])
+    Array.wrap(types).inject([]) do |flags, type|
+      flags.concat _group_flags_for(feature, type)
+    end.sort_by do |flag|
+      flag.group.name.downcase
     end
   end
 
@@ -33,7 +30,7 @@ class Detour::FlagForm
         next unless feature_params
 
         check_percentage_flag_for_deletion(feature, feature_params)
-        set_group_flag_params(feature, feature_params)
+        process_group_flags(feature, feature_params)
 
         feature.assign_attributes feature_params
         feature.save if feature.changed_for_autosave?
@@ -49,14 +46,29 @@ class Detour::FlagForm
 
   private
 
+  def _group_flags_for(feature, type)
+    send("#{type}_groups").map do |group|
+      flags = feature.send("#{flaggable_collection}_#{type}_group_flags")
+      if flag = flags.detect { |flag| flag.group.id == group.id } 
+        next flag
+      else
+        if type == "database"
+          flags.new(group_id: group.id)
+        else
+          flags.new(group_name: group.name)
+        end
+      end
+    end
+  end
+
   def check_percentage_flag_for_deletion(feature, params)
-    key         = :"#{@flaggable_type}_percentage_flag_attributes"
-    flag        = feature.send("#{@flaggable_type}_percentage_flag")
+    key         = :"#{flaggable_collection}_percentage_flag_attributes"
+    flag        = feature.send("#{flaggable_collection}_percentage_flag")
     flag_params = params[key]
 
     if flag.present? && flag_params[:percentage].blank?
-      feature.send("#{@flaggable_type}_percentage_flag").mark_for_destruction
-      feature.send("#{@flaggable_type}_percentage_flag=", nil)
+      feature.send("#{flaggable_collection}_percentage_flag").mark_for_destruction
+      feature.send("#{flaggable_collection}_percentage_flag=", nil)
     end
 
     if flag.present? && flag_params[:percentage].to_i == flag.percentage
@@ -64,23 +76,30 @@ class Detour::FlagForm
     end
   end
 
-  def set_group_flag_params(feature, params)
-    key          = :"#{@flaggable_type}_group_flags_attributes"
-    flags_params = params[key]
-    params.delete key
-
-    group_names.zip(group_flags_for(feature, false)).each do |name, flag|
-      flag_params = flags_params[name]
-      to_keep     = flag_params["to_keep"] == "1"
-      flags_params.delete name
-
-      if flag && to_keep
-        flag.to_keep = true
-      elsif flag && !to_keep
-        flag.mark_for_destruction
-      elsif !flag && to_keep
-        flag = feature.send("#{@flaggable_type}_group_flags").new group_name: name
-        flag.to_keep = true
+  def database_groups
+    @database_groups ||= Detour::Group.where(flaggable_type: @flaggable_type)
+  end
+
+  def defined_groups
+    @defined_groups ||= begin
+      (Detour::DefinedGroupFlag.where(flaggable_type: @flaggable_type).map { |flag|
+        flag.group
+      } + Detour::DefinedGroup.by_type(@flaggable_type).values).uniq(&:name)
+    end
+  end
+
+  def flaggable_collection
+    @flaggable_type.table_name
+  end
+
+  def process_group_flags(feature, params)
+    %w[defined database].each do |type|
+      key          = :"#{flaggable_collection}_#{type}_group_flags_attributes"
+      flags_params = params[key] || {}
+      params.delete key
+
+      group_flags_for(feature, type).each do |flag|
+        flag.keep_or_destroy(flags_params[flag.group_name])
       end
     end
   end

data/lib/detour/flaggable.rb

@@ -12,17 +12,7 @@ module Detour::Flaggable
   # Returns whether or not the object has access to the given feature. If given
   # a block, it will call the block if the user has access to the feature.
   #
-  # If an exception is raised in the block, it will increment the
-  # `failure_count` of the feature and raise the exception.
-  #
-  # @example
-  #   # Exceptions will be tracked in the `failure_count` of :new_user_interface.
-  #   user.has_feature?(:new_user_interface) do
-  #     # ...
-  #   end
-  #
   # @example
-  #   # Exceptions will *not* be tracked in the `failure_count` of :new_user_interface.
   #   if user.has_feature?(:new_user_interface)
   #     # ...
   #   end
@@ -48,15 +38,6 @@ module Detour::Flaggable
       end
     end
 
-    if match && block_given?
-      begin
-        yield
-      rescue => e
-        feature.increment! :failure_count
-        raise e
-      end
-    end
-
     match
   end
 

data/lib/detour/version.rb

@@ -1,3 +1,3 @@
 module Detour
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/generators/templates/migration.rb

@@ -2,7 +2,6 @@ class SetupDetour < ActiveRecord::Migration
   def change
     create_table :detour_features do |t|
       t.string :name
-      t.integer :failure_count, default: 0
       t.text    :flag_in_counts, default: "{}"
       t.text    :opt_out_counts, default: "{}"
       t.timestamps
@@ -15,6 +14,7 @@ class SetupDetour < ActiveRecord::Migration
       t.integer :feature_id
       t.integer :flaggable_id
       t.string  :flaggable_type
+      t.integer :group_id
       t.string  :group_name
       t.integer :percentage
       t.timestamps
@@ -22,11 +22,31 @@ class SetupDetour < ActiveRecord::Migration
 
     add_index :detour_flags, :type
     add_index :detour_flags, :feature_id
+    add_index :detour_flags, :group_id
+    add_index :detour_flags,
+      [:type, :feature_id, :group_id]
     add_index :detour_flags,
       [:type, :feature_id, :flaggable_type, :flaggable_id],
       name: "flag_type_feature_flaggable_type_id"
     add_index :detour_flags,
       [:type, :feature_id, :flaggable_type],
     name: "flag_type_feature_flaggable_type"
+
+    create_table :detour_groups do |t|
+      t.string :name
+      t.string :flaggable_type
+      t.timestamps
+    end
+
+    create_table :detour_memberships do |t|
+      t.integer  :group_id
+      t.string   :member_type
+      t.integer  :member_id
+      t.timestamps
+    end
+
+    add_index :detour_memberships, [:group_id, :member_type, :member_id],
+      name: :detour_memberships_membership_index,
+      unique: true
   end
 end