detour 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa9eb669cbe85bcf6e060065aa53924ec688e7be
+  data.tar.gz: ede70af5253bf7438872a8f9059bf05159b68c31
+SHA512:
+  metadata.gz: 79eaf748749d194e084fb6e42bd5bdca11dc86b5543051fb517c78cab35bd9338264187060453964320d7c0a736bac9277d6100d34be244dbc4843213bc234d5
+  data.tar.gz: d47913a017eb2cb3de39e58d41e0c62b409113ff2657e74717bbfc123059e60009f5b67bc7c8e45f6ab595f2e6901519bcac4fff440f68656865dc87143574ea

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+*.log
 .bundle
 .config
 .yardoc
@@ -12,7 +13,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-spec/spec.sqlite3
+*.sqlite3
 test/tmp
 test/version_tmp
 tmp

data/.travis.yml

@@ -1,6 +1,10 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-script: bundle exec rspec
+  - 2.1.0
+before_install: gem install bundler --version '>= 1.5.1'
+script: 
+  - RAILS_ENV=test bundle exec rake db:create
+  - RAILS_ENV=test bundle exec rake db:migrate
+  - bundle exec rspec

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in detour.gemspec
 gemspec
+
+gem "jquery-rails"
+gem "indefinite_article", ">= 0.2.0"
+
+gem "fakefs", require: false

data/README.md

@@ -16,24 +16,12 @@ Rollouts for `ActiveRecord` models. It is a spiritual fork of [ArRollout](https:
 
 - [Installation](#installation)
 - [Usage](#usage)
+  - [Configuration](#configuration)
   - [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)
-  - [Feature operations](#feature-operations)
-    - [Creating features](#creating-features)
-    - [Destroying features](#destroying-features)
-    - [Flagging a record into a feature](#flagging-a-record-into-a-feature)
-    - [Removing a flag-in for a record for a feature](#removing-a-flag-in-for-a-record-for-a-feature)
-    - [Opt a record out of a feature](#opt-a-record-out-of-a-feature)
-    - [Un-opt out a record from a feature](#un-opt-out-a-record-from-a-feature)
-    - [Flag a programmatic group into a feature](#flag-a-programmatic-group-into-a-feature)
-    - [Remove a flag-in for a programmatic group for a feature](#remove-a-flag-in-for-a-programmatic-group-for-a-feature)
-    - [Flag a percentage of records into a feature](#flag-a-percentage-of-records-into-a-feature)
-    - [Remove a flag-in for a percentage of records for a feature](#remove-a-flag-in-for-a-percentage-of-records-for-a-feature)
-  - [Defining a default class](#defining-a-default-class)
   - [Defining programmatic groups](#defining-programmatic-groups)
 - [Contributing](#contributing)
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -44,9 +32,13 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+In your rails app:
+
+    $ bundle exec rails generate detour
+
+Run the Detour migrations:
 
-    $ gem install detour
+    $ bundle exec rake db:migrate
 
 ## Usage
 
@@ -54,8 +46,42 @@ Or install it yourself as:
 should have features accessible to it based on individual flags, flags for a
 percentage of records, or flags for a programmable group of records.
 
+### Configuration
+
+Edit `config/initializers/detour.rb`:
+
+```ruby
+Detour.configure do |config|
+  # Detour needs to know at boot which models will
+  # have flags defined for them:
+  config.flaggable_types = %w[User Widget]
+
+  # Detour needs to know what directories to search
+  # through in order to find places where you're
+  # checking for flags in your code. Provide it an
+  # array of glob strings:
+  config.grep_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
+```
+
+Mount the app in `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount Detour::Engine => "/detour"
+end
+```
+
 ### Marking a model as flaggable
 
+In addition to listing classes that are flaggable in your initializer, add
+`acts_as_flaggable` to the class definitions themselves:
+
 ```ruby
 class User < ActiveRecord::Base
   acts_as_flaggable
@@ -113,123 +139,6 @@ end; else
 end
 ```
 
-### Feature operations
-
-Features and flags are intended to be controlled by a rake tasks. To create
-them programmatically, consult the documentation.
-
-#### Creating features
-
-```sh
-$ bundle exec rake detour:create[new_ui]
-```
-
-#### Destroying features
-
-```sh
-$ bundle exec rake detour:destroy[new_ui]
-```
-
-#### Flagging a record into a feature
-
-This task requires passing the feature name, the record's class, and the
-record's ID.
-
-```sh
-$ bundle exec rake detour:activate[new_ui,User,2]
-```
-
-#### Removing a flag-in for a record for a feature
-
-This task requires passing the feature name, the record's class, and the
-record's ID.
-
-```sh
-$ bundle exec rake detour:deactivate[new_ui,User,2]
-```
-
-#### Opt a record out of a feature
-
-This will ensure that `record.has_feature?(:feature)` will always be false for
-the given feature, regardless of other individual flag, percentage, or group
-rollouts that would otherwise target this record.
-
-This task requires passing the feature name, the record's class, and the
-record's ID.
-
-```sh
-$ bundle exec rake detour:opt_out[new_ui,User,2]
-```
-
-#### Un-opt out a record from a feature
-
-This task requires passing the feature name, the record's class, and the
-record's ID.
-
-```sh
-$ bundle exec rake detour:un_opt_out[new_ui,User,2]
-```
-
-#### Flag a programmatic group into a feature
-
-This task requires passing the feature name, the record class for the group,
-and the name of the group.
-
-```sh
-$ bundle exec rake detour:activate_group[new_ui,User,admins]
-```
-
-#### Remove a flag-in for a programmatic group for a feature
-
-This task requires passing the feature name, the record class for the group,
-and the name of the group.
-
-```sh
-$ bundle exec rake detour:deactivate_group[new_ui,User,admins]
-```
-
-#### Flag a percentage of records into a feature
-
-This relies on the following formula to determine if a record is flagged in to
-a feature based on percentage:
-
-```ruby
-record.id % 10 < percentage / 10
-```
-
-This task requires passing the feature name, the record class for the group,
-and the percentage of records to be flagged in.
-
-```sh
-$ bundle exec rake detour:activate_percentage[new_ui,User,20]
-```
-
-#### Remove a flag-in for a percentage of records for a feature
-
-This task requires passing the feature name, and the record class for the group.
-
-```sh
-$ bundle exec rake detour:deactivate_percentage[new_ui,User]
-```
-
-### Defining a default class
-
-In order to provide passing a class name into rake tasks, a default class can
-be set:
-
-```ruby
-Detour.configure do |config|
-  config.default_flaggable_class_name = "User"
-end
-```
-
-Then, in your rake tasks:
-
-```sh
-# Will activate feature "foo" for all instances of User that match the admins group.
-$ bundle exec rake detour:activate_group[foo,admins]
-```
-
 ### Defining programmatic groups
 
 A specific group of records matching a given block can be flagged into a

data/Rake.md

@@ -0,0 +1,108 @@
+# Detour Rake Tasks
+
+## Contents
+
+- [Creating features](#creating-features)
+- [Destroying features](#destroying-features)
+- [Flagging a record into a feature](#flagging-a-record-into-a-feature)
+- [Removing a flag-in for a record for a feature](#removing-a-flag-in-for-a-record-for-a-feature)
+- [Opt a record out of a feature](#opt-a-record-out-of-a-feature)
+- [Un-opt out a record from a feature](#un-opt-out-a-record-from-a-feature)
+- [Flag a programmatic group into a feature](#flag-a-programmatic-group-into-a-feature)
+- [Remove a flag-in for a programmatic group for a feature](#remove-a-flag-in-for-a-programmatic-group-for-a-feature)
+- [Flag a percentage of records into a feature](#flag-a-percentage-of-records-into-a-feature)
+- [Remove a flag-in for a percentage of records for a feature](#remove-a-flag-in-for-a-percentage-of-records-for-a-feature)
+
+## Creating features
+
+```sh
+$ bundle exec rake detour:create[new_ui]
+```
+
+## Destroying features
+
+```sh
+$ bundle exec rake detour:destroy[new_ui]
+```
+
+## Flagging a record into a feature
+
+This task requires passing the feature name, the record's class, and the
+record's ID.
+
+```sh
+$ bundle exec rake detour:activate[new_ui,User,2]
+```
+
+## Removing a flag-in for a record for a feature
+
+This task requires passing the feature name, the record's class, and the
+record's ID.
+
+```sh
+$ bundle exec rake detour:deactivate[new_ui,User,2]
+```
+
+## Opt a record out of a feature
+
+This will ensure that `record.has_feature?(:feature)` will always be false for
+the given feature, regardless of other individual flag, percentage, or group
+rollouts that would otherwise target this record.
+
+This task requires passing the feature name, the record's class, and the
+record's ID.
+
+```sh
+$ bundle exec rake detour:opt_out[new_ui,User,2]
+```
+
+## Un-opt out a record from a feature
+
+This task requires passing the feature name, the record's class, and the
+record's ID.
+
+```sh
+$ bundle exec rake detour:un_opt_out[new_ui,User,2]
+```
+
+## Flag a programmatic group into a feature
+
+This task requires passing the feature name, the record class for the group,
+and the name of the group.
+
+```sh
+$ bundle exec rake detour:activate_group[new_ui,User,admins]
+```
+
+## Remove a flag-in for a programmatic group for a feature
+
+This task requires passing the feature name, the record class for the group,
+and the name of the group.
+
+```sh
+$ bundle exec rake detour:deactivate_group[new_ui,User,admins]
+```
+
+## Flag a percentage of records into a feature
+
+This relies on the following formula to determine if a record is flagged in to
+a feature based on percentage:
+
+```ruby
+record.id % 10 < percentage / 10
+```
+
+This task requires passing the feature name, the record class for the group,
+and the percentage of records to be flagged in.
+
+```sh
+$ bundle exec rake detour:activate_percentage[new_ui,User,20]
+```
+
+## Remove a flag-in for a percentage of records for a feature
+
+This task requires passing the feature name, and the record class for the group.
+
+```sh
+$ bundle exec rake detour:deactivate_percentage[new_ui,User]
+```

data/Rakefile

@@ -1 +1,21 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+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