detour 0.0.1 → 0.0.2

data/lib/detour/feature.rb

@@ -1,312 +0,0 @@
-# Represents an individual feature that may be rolled out to a set of records
-# via individual flags, percentages, or defined groups.
-class Detour::Feature < ActiveRecord::Base
-  # A hash representing the groups that have been defined.
-  @defined_groups = {}
-
-  # Directories to grep for feature tests
-  @grep_dirs  = []
-
-  self.table_name = :detour_features
-
-  has_many :flaggable_flags
-  has_many :group_flags
-  has_many :percentage_flags
-  has_many :opt_out_flags
-  has_many :flags, dependent: :destroy
-
-  validates :name, presence: true, uniqueness: true
-
-  attr_accessible :name
-
-  # Returns an instance variable intended to hold an array of the lines of code
-  # that this feature appears on.
-  #
-  # @return [Array<String>] The lines that this rollout appears on (if
-  #   {Detour::Feature.all_with_lines} has already been called).
-  def lines
-    @lines ||= []
-  end
-
-  # Determines whether or not the given instance has had the feature rolled out
-  # to it either via direct flagging-in, percentage, or by group membership.
-  #
-  # @example
-  #   feature.match?(current_user)
-  #
-  # @param [ActiveRecord::Base] instance A record to be tested for feature
-  #   rollout.
-  #
-  # @return Whether or not the given instance has the feature rolled out to it.
-  def match?(instance)
-    match_id?(instance) || match_percentage?(instance) || match_groups?(instance)
-  end
-
-  # Determines whether or not the given instance has had the feature rolled out
-  # to it via direct flagging-in.
-  #
-  # @example
-  #   feature.match_id?(current_user)
-  #
-  # @param [ActiveRecord::Base] instance A record to be tested for feature
-  #   rollout.
-  #
-  # @return Whether or not the given instance has the feature rolled out to it
-  #   via direct flagging-in.
-  def match_id?(instance)
-    flaggable_flags.where(flaggable_type: instance.class.to_s, flaggable_id: instance.id).any?
-  end
-
-  # Determines whether or not the given instance has had the feature rolled out
-  # to it via percentage.
-  #
-  # @example
-  #   feature.match_percentage?(current_user)
-  #
-  # @param [ActiveRecord::Base] instance A record to be tested for feature
-  #   rollout.
-  #
-  # @return Whether or not the given instance has the feature rolled out to it
-  #   via direct percentage.
-  def match_percentage?(instance)
-    flag = percentage_flags.find(:first, conditions: ["flaggable_type = ?", instance.class.to_s])
-    percentage = flag ? flag.percentage : 0
-
-    instance.id % 10 < percentage / 10
-  end
-
-  # Determines whether or not the given instance has had the feature rolled out
-  # to it via group membership.
-  #
-  # @example
-  #   feature.match_groups?(current_user)
-  #
-  # @param [ActiveRecord::Base] instance A record to be tested for feature
-  #   rollout.
-  #
-  # @return Whether or not the given instance has the feature rolled out to it
-  #   via direct group membership.
-  def match_groups?(instance)
-    klass = instance.class.to_s
-
-    return unless self.class.defined_groups[klass]
-
-    group_names = group_flags.find_all_by_flaggable_type(klass).collect(&:group_name)
-
-    self.class.defined_groups[klass].collect { |group_name, block|
-      block.call(instance) if group_names.include? group_name
-    }.any?
-  end
-
-  class << self
-    # Returns the defined groups.
-    def defined_groups
-      @defined_groups
-    end
-
-    # Returns the default flaggable class.
-    def default_flaggable_class_name
-      @default_flaggable_class_name
-    end
-
-    # Sets the default flaggable class.
-    def default_flaggable_class_name=(klass)
-      @default_flaggable_class_name = klass
-    end
-
-    # A list of directories to search through when finding feature checks.
-    def grep_dirs
-      @grep_dirs
-    end
-
-    # Set the list of directories to search through when finding feature checks.
-    def grep_dirs=(grep_dirs)
-      @grep_dirs = grep_dirs
-    end
-
-    # Return an array of both every feature in the database as well as every
-    # feature that is checked for in `@grep_dirs`. Features that are checked
-    # for but not persisted will be returned as unpersisted instances of this
-    # class. Each instance returned will have its `@lines` set to an array
-    # containing every line in `@grep_dirs` where it is checked for.
-    #
-    # @return [Array<Detour::Feature>] Every persisted and
-    #   checked-for feature.
-    def all_with_lines
-      obj = all.each_with_object({}) { |feature, obj| obj[feature.name] = feature }
-
-      Dir[*@grep_dirs].each do |path|
-        next if File.directory? path
-
-        File.open path do |file|
-          file.each_line.with_index(1) do |line, i|
-            line.scan(/\.has_feature\?\s*\(*:(\w+)/).each do |match|
-              match = match[0]
-              obj[match] ||= find_or_initialize_by_name(match)
-              obj[match].lines << "#{path}#L#{i}"
-            end
-          end
-        end
-      end
-
-      obj.values
-    end
-
-    # Add a record to the given feature. If the feature is not found, an
-    # ActiveRecord::RecordNotFound will be raised.
-    #
-    # @example
-    #   Detour::Feature.add_record_to_feature user, :new_ui
-    #
-    # @param [ActiveRecord::Base] record A record to add the feature to.
-    # @param [String,Symbol] feature_name The feature to be added to the record.
-    #
-    # @return [Detour::Flag] The
-    #   {Detour::Flag Flag} created.
-    def add_record_to_feature(record, feature_name)
-      feature = find_by_name!(feature_name)
-      feature.flaggable_flags.where(flaggable_type: record.class.to_s, flaggable_id: record.id).first_or_create!
-    end
-
-    # Remove a record from the given feature. If the feature is not found, an
-    # ActiveRecord::RecordNotFound will be raised.
-    #
-    # @example
-    #   Detour::Feature.remove_record_from_feature user, :new_ui
-    #
-    # @param [ActiveRecord::Base] record A record to remove the feature from.
-    # @param [String,Symbol] feature_name The feature to be removed from the
-    #   record.
-    def remove_record_from_feature(record, feature_name)
-      feature = find_by_name!(feature_name)
-      feature.flaggable_flags.where(flaggable_type: record.class.to_s, flaggable_id: record.id).destroy_all
-    end
-
-    # Opt the given record out of a feature. If the feature is not found, an
-    # ActiveRecord::RecordNotFound will be raised. An opt out ensures that no
-    # matter what, `record.rollout?(:rollout)` will always return false for any
-    # opted-out-of features.
-    #
-    # @param [ActiveRecord::Base] record A record to opt out of the feature.
-    # @param [String,Symbol] feature_name The feature to be opted out of.
-    #
-    # @example
-    #   Detour::Feature.opt_record_out_of_feature user, :new_ui
-    #
-    # @return [Detour::OptOut] The
-    #   {Detour::OptOut OptOut} created.
-    def opt_record_out_of_feature(record, feature_name)
-      feature = find_by_name!(feature_name)
-      feature.opt_out_flags.where(flaggable_type: record.class.to_s, flaggable_id: record.id).first_or_create!
-    end
-
-    # Remove any opt out for the given record out of a feature. If the feature
-    # is not found, an ActiveRecord::RecordNotFound will be raised.
-    #
-    # @example
-    #   Detour::Feature.un_opt_record_out_of_feature user, :new_ui
-    #
-    # @param [ActiveRecord::Base] record A record to un-opt-out of the feature.
-    # @param [String,Symbol] feature_name The feature to be un-opted-out of.
-    def un_opt_record_out_of_feature(record, feature_name)
-      feature = find_by_name!(feature_name)
-      feature.opt_out_flags.where(flaggable_type: record.class.to_s, flaggable_id: record.id).destroy_all
-    end
-
-    # Add a group to the given feature. If the feature is not found, an
-    # ActiveRecord::RecordNotFound will be raised.
-    #
-    # @example
-    #   Detour::Feature.add_group_to_feature "User", "admin", :delete_records
-    #
-    # @param [String] flaggable_type The class (as a string) that the group
-    #   should be associated with.
-    # @param [String] group_name The name of the group to have the feature
-    #   added to it.
-    # @param [String,Symbol] feature_name The feature to be added to the group.
-    #
-    # @return [Detour::Flag] The
-    #   {Detour::Flag Flag} created.
-    def add_group_to_feature(flaggable_type, group_name, feature_name)
-      feature = find_by_name!(feature_name)
-      feature.group_flags.where(flaggable_type: flaggable_type, group_name: group_name).first_or_create!
-    end
-
-    # Remove a group from agiven feature. If the feature is not found, an
-    # ActiveRecord::RecordNotFound will be raised.
-    #
-    # @example
-    #   Detour::Feature.remove_group_from_feature "User", "admin", :delete_records
-    #
-    # @param [String] flaggable_type The class (as a string) that the group should
-    #   be removed from.
-    # @param [String] group_name The name of the group to have the feature
-    #   removed from it.
-    # @param [String,Symbol] feature_name The feature to be removed from the
-    #   group.
-    def remove_group_from_feature(flaggable_type, group_name, feature_name)
-      feature = find_by_name!(feature_name)
-      feature.group_flags.where(flaggable_type: flaggable_type, group_name: group_name).destroy_all
-    end
-
-    # Add a percentage of records to the given feature. If the feature is not
-    # found, an ActiveRecord::RecordNotFound will be raised.
-    #
-    # @example
-    #   Detour::Feature.add_percentage_to_feature "User", 75, :delete_records
-    #
-    # @param [String] flaggable_type The class (as a string) that the percetnage
-    #   should be associated with.
-    # @param [Integer] percentage The percentage of `flaggable_type` records
-    #   that the feature will be available for.
-    # @param [String,Symbol] feature_name The feature to be added to the
-    #   percentage of records.
-    #
-    # @return [Detour::Flag] The
-    #   {Detour::Flag Flag} created.
-    def add_percentage_to_feature(flaggable_type, percentage, feature_name)
-      feature = find_by_name!(feature_name)
-
-      flag = feature.percentage_flags.where(flaggable_type: flaggable_type).first_or_initialize
-      flag.update_attributes!(percentage: percentage)
-    end
-
-    # Remove any percentage flags for the given feature. If the feature is not
-    # found, an ActiveRecord::RecordNotFound will be raised.
-    #
-    # @example
-    #   Detour::Feature.remove_percentage_from_feature "User", delete_records
-    #
-    # @param [String] flaggable_type The class (as a string) that the percetnage
-    #   should be removed from.
-    # @param [String,Symbol] feature_name The feature to have the percentage
-    #   flag removed from.
-    def remove_percentage_from_feature(flaggable_type, feature_name)
-      feature = find_by_name!(feature_name)
-      feature.percentage_flags.where(flaggable_type: flaggable_type).destroy_all
-    end
-
-    # Allows for methods of the form `define_user_group` that call the private
-    # method `define_group_for_class`. A new group for any `User` records will
-    # be created that rollouts can be attached to.
-    #
-    # @example
-    #   Detour::Feature.define_user_group :admins do |user|
-    #     user.admin?
-    #   end
-    def method_missing(method, *args, &block)
-      if /^define_(?<klass>[a-z0-9_]+)_group/ =~ method
-        define_group_for_class(klass.classify, args[0], &block)
-      else
-        super
-      end
-    end
-
-    private
-
-    def define_group_for_class(klass, group_name, &block)
-      @defined_groups[klass] ||= {}
-      @defined_groups[klass][group_name] = block
-    end
-  end
-end

data/lib/detour/flaggable_flag.rb

@@ -1,10 +0,0 @@
-# An individual record of a certain type may be flagged into a feature with
-# this class.
-class Detour::FlaggableFlag < Detour::Flag
-  belongs_to :flaggable, polymorphic: true
-
-  validates :flaggable_id, presence: true
-  validates :feature_id, uniqueness: { scope: [:flaggable_type, :flaggable_id] }
-
-  attr_accessible :flaggable
-end

data/lib/detour/group_flag.rb

@@ -1,8 +0,0 @@
-# A group of flaggable records of a given class may be flagged into a feature
-# with this class.
-class Detour::GroupFlag < Detour::Flag
-  validates :group_name, presence: true
-
-  attr_accessible :group_name
-  validates :feature_id, uniqueness: { scope: [:flaggable_type, :group_name] }
-end

data/lib/detour/percentage_flag.rb

@@ -1,11 +0,0 @@
-# A percentage of flaggable records of a given class may be flagged into a feature
-# with this class.
-class Detour::PercentageFlag < Detour::Flag
-  validates :percentage,
-    presence: true,
-    numericality: { greater_than: 0, less_than_or_equal_to: 100 }
-
-  validates :feature_id, uniqueness: { scope: :flaggable_type }
-
-  attr_accessible :percentage
-end

data/spec/lib/active_record/rollout/acts_as_flaggable_spec.rb

@@ -1,31 +0,0 @@
-require "spec_helper"
-
-describe Detour::ActsAsFlaggable do
-  subject { User.new }
-
-  it { should have_many :flaggable_flags }
-  it { should have_many :opt_out_flags }
-  it { should have_many(:features).through(:flaggable_flags) }
-
-  it "includes Detour::Flaggable" do
-    subject.class.ancestors.should include Detour::Flaggable
-  end
-
-  describe "#acts_as_flaggable" do
-    context "when given a :find_by parameter" do
-      class Foo < ActiveRecord::Base
-        acts_as_flaggable find_by: :email
-      end
-
-      it "sets the appropriate class variable on the class" do
-        Foo.instance_variable_get("@detour_flaggable_find_by").should eq :email
-      end
-    end
-
-    context "when not given a :find_by parameter" do
-      it "uses the default :id value for flaggable_find_by" do
-        User.instance_variable_get("@detour_flaggable_find_by").should eq :id
-      end
-    end
-  end
-end

data/spec/lib/active_record/rollout/flaggable_flag_spec.rb

@@ -1,9 +0,0 @@
-require "spec_helper"
-
-describe Detour::FlaggableFlag do
-  it { should be_a Detour::Flag }
-  it { should belong_to :flaggable }
-  it { should validate_presence_of :flaggable_id }
-  it { should allow_mass_assignment_of :flaggable }
-  it { should validate_uniqueness_of :feature_id }
-end

data/spec/lib/active_record/rollout/opt_out_flag_spec.rb

@@ -1,9 +0,0 @@
-require "spec_helper"
-
-describe Detour::OptOutFlag do
-  it { should be_a Detour::Flag }
-  it { should belong_to :flaggable }
-  it { should validate_presence_of :flaggable_id }
-  it { should allow_mass_assignment_of :flaggable}
-  it { should validate_uniqueness_of :feature_id }
-end

data/spec/support/schema.rb

@@ -1,13 +0,0 @@
-ActiveRecord::Schema.define do
-  self.verbose = false
-
-  create_table :users, force: true do |t|
-    t.string :name
-    t.timestamps
-  end
-
-  create_table :organizations, force: true do |t|
-    t.string :name
-    t.timestamps
-  end
-end