detour 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ca146964bc97965e5f1b493fb87c8c4fcd2b149
-  data.tar.gz: da57f56e5998a03bc6559958a9dcc54f2bf62629
+  metadata.gz: 8684efda0b28c3dbd1dd637adced4476063e1b69
+  data.tar.gz: 7b8de882f70365420e74d75734583ac336f58762
 SHA512:
-  metadata.gz: 4cdaf7bcfec46bdadbbc147f6baaddabf373fe610172afb531805f82250c3b292581281ba5a11aeeaac98dd87fd77ceb4e980d4165a7e0ca0a07fa2c1a8245e8
-  data.tar.gz: d2535f168cadb5ff31bcd23055d96cac22971d8521a97903407563de976b741faada4ade8cb1ed826edb71ef8e94cac4439c38161787bec14de9be9ef13541b2
+  metadata.gz: 070f25d30517f8f1dbd062087e90db55f15b1a51a7eb456211a57123f71314ec33d93417d06ac5921ec2815fb784c8f666b2765a7c8eb290e8163188ce135849
+  data.tar.gz: 0080ba77c52c9de244cdc68676519ff81148ee4e190e60f5c9d9c54e903cfd343c1e5f6bd0861d239c66073e085977e658d57bc2fd01dc54525f2edec78b2391

data/README.md

@@ -1,6 +1,7 @@
 # Detour
 
-Rollouts for `ActiveRecord` models. It is a spiritual fork of [ArRollout](https://github.com/markpundsack/ar_rollout).
+Rollouts for `ActiveRecord` models. It is a spiritual fork of
+[ArRollout](https://github.com/markpundsack/ar_rollout).
 
 | development status | master status | Code Climate |
 | ------------------ | ------------- | ------------ |
@@ -17,6 +18,7 @@ Rollouts for `ActiveRecord` models. It is a spiritual fork of [ArRollout](https:
 - [Installation](#installation)
 - [Usage](#usage)
   - [Configuration](#configuration)
+  - [Restricting the admin interface](#restricting-the-admin-interface)
   - [Marking a model as flaggable](#marking-a-model-as-flaggable)
   - [Determining if a record is flagged into a feature](#determining-if-a-record-is-flagged-into-a-feature)
   - [Defining programmatic groups](#defining-programmatic-groups)
@@ -44,7 +46,8 @@ Run the Detour migrations:
 
 `Detour` works by determining whether or not a specific record
 should have features accessible to it based on individual flags, flags for a
-percentage of records, or flags for a programmable group of records.
+percentage of records, flags for a database-backed group of records, or flags
+for a code-defined group of records.
 
 ### Configuration
 
@@ -61,11 +64,6 @@ Detour.configure do |config|
   # checking for flags in your code. Provide it an
   # array of glob strings:
   config.feature_search_dirs = %w[app/**/*.{rb,erb}]
-
-  # Provide a default class to manage rollouts for, if
-  # desired. This means you can omit the class name from
-  # rake tasks:
-  config.default_flaggable_class_name = "User"
 end
 ```
 
@@ -77,6 +75,37 @@ Rails.application.routes.draw do
 end
 ```
 
+### Restricting the admin interface
+
+If you'd like your Detour admin interface only accessible to admins, for example,
+you can add a `before_filter` to `Detour::ApplicationController` in the Detour
+initializer:
+
+```ruby
+# config/initializers/detour.rb
+
+Detour::ApplicationController.class_eval do
+  include CurrentUser
+
+  before_filter :admin_required!
+
+  private
+
+  def admin_required!
+    if current_user && current_user.admin?
+      true
+    else
+      # redirect somewhere for non-admins
+    end
+  end
+end
+```
+
+Since `Detour::ApplicationController` isn't a subclass of my `ApplicationController`,
+I've included a `CurrentUser` module that I built in this app that adds a
+`current_user` method to any controller that it's included in. Now, only admins
+will have access to the Detour admin interface.
+
 ### Marking a model as flaggable
 
 In addition to listing classes that are flaggable in your initializer, add

data/app/controllers/detour/flaggable_flags_controller.rb

@@ -4,9 +4,10 @@ class Detour::FlaggableFlagsController < Detour::ApplicationController
   include Detour::FlaggableFlagsHelper
 
   before_filter :ensure_flaggable_type_exists
+  before_filter :ensure_flag_type_exists
 
   def index
-    @feature = Detour::Feature.find_by_name!(params[:feature_name])
+    @feature = Detour::Feature.where(name: params[:feature_name]).first_or_create!
   end
 
   def update
@@ -14,9 +15,17 @@ class Detour::FlaggableFlagsController < Detour::ApplicationController
 
     if @feature.update_attributes(params[:feature])
       flash[:notice] = "Your #{flag_noun.pluralize} have been updated"
-      redirect_to send("#{flag_type}_flags_path", feature_name: params[:feature_name], flaggable_type: params[:flaggable_type])
+      redirect_to flaggable_flags_path flag_type: params[:flag_type], feature_name: params[:feature_name], flaggable_type: params[:flaggable_type]
     else
       render :index
     end
   end
+
+  private
+
+  def ensure_flag_type_exists
+    unless %w[flag-ins opt-outs].include? params[:flag_type]
+      raise ActionController::RoutingError.new("Not Found")
+    end
+  end
 end

data/app/helpers/detour/flaggable_flags_helper.rb

@@ -12,7 +12,7 @@ module Detour::FlaggableFlagsHelper
   end
 
   def flag_type
-    request.path.split("/")[2].underscore.singularize
+    params[:flag_type].underscore
   end
 
   def flag_verb

data/app/models/detour/feature.rb

@@ -8,12 +8,12 @@ class Detour::Feature < ActiveRecord::Base
   serialize :flag_in_counts, JSON
   serialize :opt_out_counts, JSON
 
-  has_many :flag_in_flags
-  has_many :defined_group_flags
-  has_many :database_group_flags
-  has_many :percentage_flags
-  has_many :opt_out_flags
-  has_many :flags, dependent: :destroy
+  has_many :flag_in_flags,        dependent: :destroy
+  has_many :defined_group_flags,  dependent: :destroy
+  has_many :database_group_flags, dependent: :destroy
+  has_many :percentage_flags,     dependent: :destroy
+  has_many :opt_out_flags,        dependent: :destroy
+  has_many :flags,                dependent: :destroy
 
   validates_presence_of   :name
   validates_uniqueness_of :name

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

@@ -33,13 +33,13 @@
     <% end %>
 
     <td class="flag-in-count">
-      <%= link_to flag_in_flags_path(feature.name, params[:flaggable_type]) do %>
+      <%= link_to flaggable_flags_path(flag_type: "flag-ins", feature_name: feature.name, flaggable_type: params[:flaggable_type]) do %>
         <%= feature.flag_in_count_for(params[:flaggable_type]) %>
       <% end %>
     </td>
 
     <td class="opt-out-count">
-      <%= link_to opt_out_flags_path(feature.name, params[:flaggable_type]) do %>
+      <%= link_to flaggable_flags_path(flag_type: "opt-outs", feature_name: feature.name, flaggable_type: params[:flaggable_type]) do %>
         <%= feature.opt_out_count_for(params[:flaggable_type]) %>
       <% end %>
     </td>

data/config/routes.rb

@@ -5,12 +5,10 @@ Detour::Engine.routes.draw do
   resources :features, only: [:create, :destroy]
   resources :groups, only: [:index, :show, :create, :update, :destroy]
 
-  %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
+  scope "/:flag_type/:feature_name" do
+    get    ":flaggable_type"     => "flaggable_flags#index",   as: "flaggable_flags"
+    put    ":flaggable_type"     => "flaggable_flags#update"
+    delete ":flaggable_type/:id" => "flaggable_flags#destroy", as: "flaggable_flag"
   end
 
   root to: "application#index"

data/lib/detour/configuration.rb

@@ -1,7 +1,6 @@
 class Detour::Configuration
   attr_reader   :defined_groups
   attr_reader   :feature_search_regex
-  attr_accessor :default_flaggable_class_name
   attr_accessor :flaggable_types
   attr_accessor :feature_search_dirs
 

data/lib/detour/version.rb

@@ -1,3 +1,3 @@
 module Detour
-  VERSION = "0.0.7"
+  VERSION = "0.0.9"
 end

data/spec/controllers/detour/flaggable_flags_controller_spec.rb

@@ -6,57 +6,96 @@ describe Detour::FlaggableFlagsController do
   describe "GET #index" do
     let(:flag) { create :flag_in_flag }
 
-    before do
-      get :index, feature_name: flag.feature.name, flaggable_type: "users"
+    context "when the flag type is invalid" do
+      def do_get
+        get :index, flag_type: "foo", feature_name: flag.feature.name, flaggable_type: "users"
+      end
+
+      it "returns a 404" do
+        expect { do_get }.to raise_error ActionController::RoutingError
+      end
     end
 
-    it "assigns the feature" do
-      assigns(:feature).should eq flag.feature
+    context "when the feature does not exist" do
+      before do
+        get :index, flag_type: "flag-ins", feature_name: "foo", flaggable_type: "users"
+      end
+
+      it "persists the feature" do
+        Detour::Feature.where(name: "foo").should_not be_nil
+      end
+
+      it "is a 200" do
+        response.status.should eq 200
+      end
     end
 
-    it "renders the index template" do
-      response.should render_template :index
+    context "when the flag type is valid" do
+      before do
+        get :index, flag_type: "flag-ins", feature_name: flag.feature.name, flaggable_type: "users"
+      end
+
+      it "assigns the feature" do
+        assigns(:feature).should eq flag.feature
+      end
+
+      it "renders the index template" do
+        response.should render_template :index
+      end
     end
   end
 
   describe "PUT #update" do
     let(:flag) { create :flag_in_flag }
 
-    before do
-      put :update, feature_name: flag.feature.name, flaggable_type: "users", feature: flag_params
+    context "when the flag type is invalid" do
+      def do_put
+        put :update, flag_type: "foo", feature_name: flag.feature.name, flaggable_type: "users", feature: {}
+      end
+
+      it "returns a 404" do
+        expect { do_put }.to raise_error ActionController::RoutingError
+      end
     end
 
-    context "when successful" do
-      let(:user) { create :user }
 
-      let(:flag_params) do
-        {
-          users_flag_ins_attributes: {
-            "1" => { flaggable_type: "User", flaggable_key: user.id, _destroy: 0 }
-          }
-        }
+    context "when the flag type is valid" do
+      before do
+        put :update, flag_type: "flag-ins", feature_name: flag.feature.name, flaggable_type: "users", feature: flag_params
       end
 
-      it "sets a flash message" do
-        flash[:notice].should eq "Your flag-ins have been updated"
-      end
+      context "when successful" do
+        let(:user) { create :user }
 
-      it "redirect to the group" do
-        response.should redirect_to flag_in_flags_path(feature_name: flag.feature.name, flaggable_type: "users")
+        let(:flag_params) do
+          {
+            users_flag_ins_attributes: {
+              "1" => { flaggable_type: "User", flaggable_key: user.id, _destroy: 0 }
+            }
+          }
+        end
+
+        it "sets a flash message" do
+          flash[:notice].should eq "Your flag-ins have been updated"
+        end
+
+        it "redirect to the group" do
+          response.should redirect_to flaggable_flags_path(flag_type: "flag-ins", feature_name: flag.feature.name, flaggable_type: "users")
+        end
       end
-    end
 
-    context "when unsuccessful" do
-      let(:flag_params) do
-        {
-          users_flag_ins_attributes: {
-            "1" => { flaggable_type: "User", flaggable_key: nil, _destroy: 0 }
+      context "when unsuccessful" do
+        let(:flag_params) do
+          {
+            users_flag_ins_attributes: {
+              "1" => { flaggable_type: "User", flaggable_key: nil, _destroy: 0 }
+            }
           }
-        }
-      end
+        end
 
-      it "renders the show template" do
-        response.should render_template :index
+        it "renders the show template" do
+          response.should render_template :index
+        end
       end
     end
   end

data/spec/models/detour/feature_spec.rb

@@ -2,11 +2,11 @@ require "spec_helper"
 require "fakefs/spec_helpers"
 
 describe Detour::Feature do
-  it { should have_many(:flag_in_flags) }
-  it { should have_many(:database_group_flags) }
-  it { should have_many(:defined_group_flags) }
-  it { should have_many(:percentage_flags) }
-  it { should have_many(:opt_out_flags) }
+  it { should have_many(:flag_in_flags).dependent(:destroy) }
+  it { should have_many(:database_group_flags).dependent(:destroy) }
+  it { should have_many(:defined_group_flags).dependent(:destroy) }
+  it { should have_many(:percentage_flags).dependent(:destroy) }
+  it { should have_many(:opt_out_flags).dependent(:destroy) }
   it { should have_many(:flags).dependent(:destroy) }
   it { should validate_presence_of :name }
   it { should validate_uniqueness_of :name }
@@ -16,6 +16,7 @@ describe Detour::Feature do
   it { should allow_value("foo_bar").for(:name) }
   it { should allow_value("foo-bar").for(:name) }
   it { should_not allow_value("foo-bar.").for(:name) }
+  it { should_not allow_value("foo bar").for(:name) }
 
   describe "name format validation" do
     let(:feature) { build :feature, name: "foo bar." }

data/spec/spec_helper.rb

@@ -57,7 +57,6 @@ RSpec.configure do |config|
   end
 
   config.after :each do
-    Detour.config.default_flaggable_class_name = nil
     Detour.config.feature_search_dirs = []
     Detour.config.instance_variable_set "@defined_groups", {}
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: detour
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Jonathan Clem
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-08 00:00:00.000000000 Z
+date: 2014-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails