Merge pull request #506 from jjb/patch-2

ability to hide settings view

README.md

@@ -238,6 +238,14 @@ This feature is enabled by default. To stop this feature, disable the feature in
 
 ![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_view_tracker.png)
 
+### Hiding settings
+
+Coverband provides a view of all of its current settings. Sometimes you might want to hide this view,
+such as when sharing coverband data with a large number of developers of varying trust levels.
+You can disable the settings view like so:
+
+`config.hide_settings = false`
+
 ### Fixing Coverage Only Shows Loading Hits
 
 If all your coverage is being counted as loading or eager_loading coverage, and nothing is showing as runtime Coverage the initialization hook failed for some reason. The most likely reason for this issue is manually calling `eager_load!` on some Plugin/Gem. If you or a plugin is altering the Rails initialization process, you can manually flip Coverband to runtime coverage by calling these two lines, in an `after_initialize` block, in `application.rb`.

lib/coverband/configuration.rb

@@ -11,7 +11,7 @@ class Configuration
       :view_tracker, :defer_eager_loading_data,
       :track_routes, :route_tracker,
       :track_translations, :translations_tracker,
-      :trackers, :csp_policy
+      :trackers, :csp_policy, :hide_settings
 
     attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id,
       :s3_secret_access_key, :password, :api_key, :service_url, :coverband_timeout, :service_dev_mode,
@@ -86,6 +86,7 @@ def reset
       @all_root_patterns = nil
       @password = nil
       @csp_policy = false
+      @hide_settings = false
 
       # coverband service settings
       @api_key = nil

lib/coverband/reporters/web.rb

@@ -122,6 +122,7 @@ def json
       end
 
       def settings
+        return "" if Coverband.configuration.hide_settings
         Coverband::Utils::HTMLFormatter.new(nil, base_path: base_path).format_settings!
       end