Docs & better structure for configure_entry_search_strategy

Dave Sims · Dave Sims · commit efcf91517b9d · 2016-07-08T13:53:12.000-05:00
diff --git a/lib/github/ldap.rb b/lib/github/ldap.rb
@@ -261,13 +261,18 @@ def configure_search_strategy(strategy = nil)
       configure_member_search_strategy(strategy)
     end
 
+    # Internal: Configure the entry search strategy.
+    #
+    # If the user has configured GHE to use forest searches AND we have an active
+    # Directory instance that has the right capabilities, use a ForestSearch
+    # strategy. Otherwise, the entry search strategy is simple the existing LDAP
+    # connection object.
+    #
     def configure_entry_search_strategy(use_forest_search)
-      @entry_search_strategy = begin
-        if use_forest_search && active_directory_capability? &&  capabilities[:configurationnamingcontext].any?
-          @entry_search_strategy = GitHub::Ldap::ForestSearch.new(@connection)
-        else
-          @entry_search_strategy = @connection
-        end
+      @entry_search_strategy = if use_forest_search && active_directory_capability? && capabilities[:configurationnamingcontext].any?
+        @entry_search_strategy = GitHub::Ldap::ForestSearch.new(@connection)
+      else
+        @entry_search_strategy = @connection
       end
     end
 
@@ -322,7 +327,6 @@ def configure_member_search_strategy(strategy = nil)
         end
     end
 
-
     # Internal: Detect whether the LDAP host is an ActiveDirectory server.
     #
     # See: http://msdn.microsoft.com/en-us/library/cc223359.aspx.
