detour 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f0d93b6f88bfbc32c18a69476133c35adbc77a7
-  data.tar.gz: 64fd4443f00d265b48f3fdff2d7124c590bfd994
+  metadata.gz: 8ca146964bc97965e5f1b493fb87c8c4fcd2b149
+  data.tar.gz: da57f56e5998a03bc6559958a9dcc54f2bf62629
 SHA512:
-  metadata.gz: d4cb09c0a64c6754a6987703695cda08a5205bfa954af3137be55cf1291b31a34d3c5fb487b0814aa7328af0dc44b06654e249f0714ffef8b831718ccb9d68e1
-  data.tar.gz: 080c630df51ba8a28bad603fb088256ec9a370f2aab18c8d3567fd0e7568fea54a0be1bb7ef84b28a93d70b70d692e0dc05dc4fbf6e1690306ba402cd723dd15
+  metadata.gz: 4cdaf7bcfec46bdadbbc147f6baaddabf373fe610172afb531805f82250c3b292581281ba5a11aeeaac98dd87fd77ceb4e980d4165a7e0ca0a07fa2c1a8245e8
+  data.tar.gz: d2535f168cadb5ff31bcd23055d96cac22971d8521a97903407563de976b741faada4ade8cb1ed826edb71ef8e94cac4439c38161787bec14de9be9ef13541b2

data/README.md

@@ -60,7 +60,7 @@ Detour.configure do |config|
   # 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}]
+  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

data/app/models/detour/feature.rb

@@ -55,22 +55,22 @@ class Detour::Feature < ActiveRecord::Base
   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
+  # feature that is checked for in `@feature_search_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.
+  # containing every line in `@feature_search_dirs` where it is checked for.
   #
   # @return [Array<Detour::Feature>] Every persisted and
   #   checked-for feature.
   def self.with_lines
     hash = all.each_with_object({}) { |feature, hash| hash[feature.name] = feature }
 
-    Dir[*Detour.config.grep_dirs].each do |path|
+    Dir[*Detour.config.feature_search_dirs].each do |path|
       next unless File.file? path
 
       File.open path do |file|
         file.each_line.with_index(1) do |line, i|
-          line.scan(/\.has_feature\?\s*\(?[:"]([\w-]+)/).each do |match, _|
+          line.scan(feature_search_regex).each do |match, _|
             (hash[match] ||= new(name: match)).lines << "#{path}#L#{i}"
           end
         end
@@ -79,4 +79,9 @@ class Detour::Feature < ActiveRecord::Base
 
     hash.values.sort_by(&:name)
   end
+
+  def self.feature_search_regex
+    Detour.config.feature_search_regex || /\.has_feature\?\s*\(?[:"]([\w-]+)/
+  end
+  private_class_method :feature_search_regex
 end

data/lib/detour/configuration.rb

@@ -1,13 +1,29 @@
 class Detour::Configuration
   attr_reader   :defined_groups
+  attr_reader   :feature_search_regex
   attr_accessor :default_flaggable_class_name
   attr_accessor :flaggable_types
-  attr_accessor :grep_dirs
+  attr_accessor :feature_search_dirs
 
   def initialize
-    @defined_groups  = {}
-    @flaggable_types = []
-    @grep_dirs       = []
+    @defined_groups      = {}
+    @flaggable_types     = []
+    @feature_search_dirs = []
+  end
+
+  # Defines the regular expression used to search for features. It must include
+  # a single match group.
+  #
+  # @example
+  #   Detour.config.feature_search_regex = /\.rollout\? :(\w+)/
+  #
+  # @param [Regexp] regex A regex to use to search for feature checks with.
+  def feature_search_regex=(regex)
+    if regex.is_a? Regexp
+      @feature_search_regex = regex
+    else
+      raise "Feature search regex must be an instance of Regexp"
+    end
   end
 
   # Allows for methods of the form `define_user_group` that call the private

data/lib/detour/version.rb

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

data/spec/controllers/detour/flags_controller_spec.rb

@@ -5,7 +5,7 @@ describe Detour::FlagsController do
 
   describe "GET #index" do
     before do
-      Detour.config.grep_dirs = ["spec/dummy/app/**/*.{rb,erb}"]
+      Detour.config.feature_search_dirs = ["spec/dummy/app/**/*.{rb,erb}"]
       get :index, flaggable_type: "users"
     end
 

data/spec/dummy/config/initializers/detour.rb

@@ -3,7 +3,7 @@ Detour.configure do |config|
   #   user.admin?
   # end
 
-  config.grep_dirs = %w[app/**/*.{rb,erb}]
+  config.feature_search_dirs = %w[app/**/*.{rb,erb}]
 
   config.flaggable_types = %w[User Widget]
 

data/spec/features/features_spec.rb

@@ -15,7 +15,7 @@ describe "listing features for a type" do
 
 
   before do
-    Detour.config.grep_dirs = %w[spec/dummy/app/**/*.{rb,erb}]
+    Detour.config.feature_search_dirs = %w[spec/dummy/app/**/*.{rb,erb}]
     visit "/detour/flags/users"
   end
 

data/spec/lib/detour/configuration_spec.rb

@@ -17,6 +17,21 @@ describe Detour::Configuration do
     end
   end
 
+  describe ".feature_search_regex=" do
+    context "when given a regex" do
+      it "sets the feature search regex" do
+        subject.feature_search_regex = /foo/
+        subject.feature_search_regex.should eq /foo/
+      end
+    end
+
+    context "when not given a regex" do
+      it "raises an exception" do
+        expect { subject.feature_search_regex = "string" }.to raise_error "Feature search regex must be an instance of Regexp"
+      end
+    end
+  end
+
   describe ".define_{klass}_group" do
     let(:block) { Proc.new {} }
     it "defines a group for the given class" do

data/spec/lib/detour/flag_form_spec.rb

@@ -7,7 +7,7 @@ describe Detour::FlagForm do
 
   describe "#features" do
     before do
-      Detour.config.grep_dirs = ["spec/dummy/app/**/*.{rb,erb}"]
+      Detour.config.feature_search_dirs = ["spec/dummy/app/**/*.{rb,erb}"]
     end
 
     it "returns every feature including lines" do

data/spec/models/detour/feature_spec.rb

@@ -32,7 +32,7 @@ describe Detour::Feature do
     let(:feature) { create :feature, name: "foo" }
 
     before do
-      Detour.config.grep_dirs = ["/foo/**/*.rb"]
+      Detour.config.feature_search_dirs = ["/foo/**/*.rb"]
 
       FileUtils.mkdir("/foo")
 
@@ -46,6 +46,9 @@ describe Detour::Feature do
 
           current_user.has_feature?(:foo) do
           end
+
+          current_user.rollout?(:foo) do
+          end
         EOF
       end
 
@@ -59,6 +62,21 @@ describe Detour::Feature do
       end
     end
 
+    context "when there is a custom feature search regex" do
+      before do
+        Detour.config.feature_search_regex = /rollout\?\(:(\w+)\)/
+      end
+
+      after do
+        Detour.config.instance_variable_set "@feature_search_regex", nil
+      end
+
+      it "uses the custom feature search regex" do
+        persisted_feature = Detour::Feature.with_lines.detect { |f| f.name == feature.name }
+        persisted_feature.lines.should eq %w[/foo/bar.rb#L10]
+      end
+    end
+
     it "fetches lines for persisted features" do
       persisted_feature = Detour::Feature.with_lines.detect { |f| f.name == feature.name }
       persisted_feature.lines.should eq %w[/foo/bar.rb#L1 /foo/bar.rb#L7 /foo/baz.rb#L1]

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: detour
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Jonathan Clem