Revert back to using cli option --publish-quiet instead of --no-publish-ad

cbliard · cbliard · commit d08223592486 · 2020-08-17T12:16:06.000+02:00
This reverts commit d0f9d2f.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,8 +15,8 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 ### Added
 
 * `--publish` automatically publishes reports to [reports.cucumber.io](https://reports.cucumber.io)
-* `--no-publish-ad` does not print information banner about [reports.cucumber.io](https://reports.cucumber.io)
-* `-q, --quiet` will also imply `--no-publish-ad` in addition to `--no-snippets --no-source --no-duration`
+* `--publish-quiet` does not print information banner about [reports.cucumber.io](https://reports.cucumber.io)
+* `-q, --quiet` will also imply `--publish-quiet` in addition to `--no-snippets --no-source --no-duration`
 
 ### Changed
 
diff --git a/features/docs/cli/dry_run.feature b/features/docs/cli/dry_run.feature
@@ -13,7 +13,7 @@ Feature: Dry Run
           Given this step fails
       """
     And the standard step definitions
-    When I run `cucumber --dry-run --no-publish-ad`
+    When I run `cucumber --dry-run --publish-quiet`
     Then it should pass with exactly:
       """
       Feature: test
@@ -34,7 +34,7 @@ Feature: Dry Run
           Given this step fails
       """
     And the standard step definitions
-    When I run `cucumber --dry-run --strict --no-publish-ad`
+    When I run `cucumber --dry-run --strict --publish-quiet`
     Then it should pass with exactly:
       """
       Feature: test
diff --git a/features/docs/cli/publish_banner.feature b/features/docs/cli/publish_banner.feature
@@ -21,17 +21,17 @@ Feature: Publish banner
     │ More information at https://reports.cucumber.io/docs/cucumber-ruby       │
     │                                                                          │
     │ To disable this message, specify CUCUMBER_PUBLISH_QUIET=true or use the  │
-    │ --no-publish-ad option. You can also add this to your cucumber.yml:      │
-    │ default: --no-publish-ad                                                 │
+    │ --publish-quiet option. You can also add this to your cucumber.yml:      │
+    │ default: --publish-quiet                                                 │
     └──────────────────────────────────────────────────────────────────────────┘
     """
 
-  Scenario: Banner is not displayed when using --no-publish-ad
+  Scenario: Banner is not displayed when using --publish-quiet
     Given a file named "features/hello.feature" with:
     """
     Feature: Hello
     """
-    When I run `cucumber --no-publish-ad`
+    When I run `cucumber --publish-quiet`
     Then the output should not contain:
     """
     Share your Cucumber Report with your team at https://reports.cucumber.io
diff --git a/features/docs/cli/specifying_multiple_formatters.feature b/features/docs/cli/specifying_multiple_formatters.feature
@@ -18,7 +18,7 @@ Feature: Running multiple formatters
     """
 
   Scenario: Multiple formatters and outputs
-    When I run `cucumber --no-color --format progress --out progress.txt --format pretty --out pretty.txt --no-source --dry-run --no-snippets features/test.feature --no-publish-ad`
+    When I run `cucumber --no-color --format progress --out progress.txt --format pretty --out pretty.txt --no-source --dry-run --no-snippets features/test.feature --publish-quiet`
     Then the stderr should not contain anything
     Then the file "progress.txt" should contain:
       """
diff --git a/features/docs/defining_steps/ambiguous_steps.feature b/features/docs/defining_steps/ambiguous_steps.feature
@@ -72,7 +72,7 @@ Feature: Ambiguous Steps
         'bar'
       end
     """
-    When I run `cucumber -g --no-publish-ad`
+    When I run `cucumber -g --publish-quiet`
     Then it should pass with exactly:
     """
     Feature:
diff --git a/features/docs/defining_steps/table_diffing.feature b/features/docs/defining_steps/table_diffing.feature
@@ -22,7 +22,7 @@ Feature: Table diffing
         }))
       end
       """
-    When I run `cucumber features/tables.feature --no-publish-ad`
+    When I run `cucumber features/tables.feature --publish-quiet`
     Then it should fail with exactly:
       """
       Feature: Tables
diff --git a/features/docs/exception_in_before_hook.feature b/features/docs/exception_in_before_hook.feature
@@ -51,7 +51,7 @@ Feature: Exception in Before Block
         Scenario: Run a good step
           Given this step passes
       """
-    When I run `cucumber features --no-publish-ad`
+    When I run `cucumber features --publish-quiet`
     Then it should fail with exactly:
       """
       Feature: Sample
diff --git a/features/docs/extending_cucumber/custom_formatter.feature b/features/docs/extending_cucumber/custom_formatter.feature
@@ -30,7 +30,7 @@ Feature: Custom Formatter
         end
       end
       """
-    When I run `cucumber features/f.feature --format MyCustom::Formatter --no-publish-ad`
+    When I run `cucumber features/f.feature --format MyCustom::Formatter --publish-quiet`
     Then it should pass with exactly:
       """
         JUST PRINT ME
@@ -51,7 +51,7 @@ Feature: Custom Formatter
         end
       end
       """
-    When I run `cucumber features/f.feature --format MyCustom::Formatter,foo=bar,one=two --no-publish-ad`
+    When I run `cucumber features/f.feature --format MyCustom::Formatter,foo=bar,one=two --publish-quiet`
     Then it should pass with exactly:
     """
     {"foo"=>"bar", "one"=>"two"}
diff --git a/features/docs/formatters/junit_formatter.feature b/features/docs/formatters/junit_formatter.feature
@@ -337,7 +337,7 @@ You *must* specify --out DIR for the junit formatter
       """
 
   Scenario: strict mode with --expand option, one feature, one scenario outline, four examples: one passing, one failing, one pending, one undefined
-    When I run `cucumber --strict --expand --format junit --out tmp/ features/scenario_outline.feature --no-publish-ad`
+    When I run `cucumber --strict --expand --format junit --out tmp/ features/scenario_outline.feature --publish-quiet`
     Then it should fail with exactly:
       """
 
diff --git a/features/docs/formatters/rerun_formatter.feature b/features/docs/formatters/rerun_formatter.feature
@@ -34,7 +34,7 @@ Feature: Rerun formatter
 
       """
 
-    When I run `cucumber --no-publish-ad -f rerun`
+    When I run `cucumber --publish-quiet -f rerun`
     Then it should pass with exactly:
       """
       """
@@ -65,7 +65,7 @@ Feature: Rerun formatter
           Given this step passes
       """
 
-    When I run `cucumber --no-publish-ad -f rerun --dry-run`
+    When I run `cucumber --publish-quiet -f rerun --dry-run`
     Then it should pass with exactly:
       """
       """
@@ -96,7 +96,7 @@ Feature: Rerun formatter
           Given this step passes
       """
 
-    When I run `cucumber --no-publish-ad -f rerun --strict`
+    When I run `cucumber --publish-quiet -f rerun --strict`
     Then it should fail with exactly:
       """
       features/mixed.feature:3:6:9
diff --git a/features/docs/formatters/summary_formatter.feature b/features/docs/formatters/summary_formatter.feature
@@ -16,7 +16,7 @@ Feature: Spec formatter
       Scenario: Failing
         Given this step fails
     """
-    When I run `cucumber --format summary --no-publish-ad`
+    When I run `cucumber --format summary --publish-quiet`
     Then it should fail with exactly:
     """
     Test
diff --git a/features/docs/formatters/usage_formatter.feature b/features/docs/formatters/usage_formatter.feature
@@ -31,7 +31,7 @@ Feature: Usage formatter
       """
 
   Scenario: Run with --format usage
-    When I run `cucumber -f usage --dry-run --no-publish-ad`
+    When I run `cucumber -f usage --dry-run --publish-quiet`
     Then it should pass with exactly:
       """
       -----------
@@ -56,7 +56,7 @@ Feature: Usage formatter
       """
 
   Scenario: Run with --expand --format usage
-    When I run `cucumber -x -f usage --dry-run --no-publish-ad`
+    When I run `cucumber -x -f usage --dry-run --publish-quiet`
     Then it should pass with exactly:
       """
       -----------
@@ -81,7 +81,7 @@ Feature: Usage formatter
       """
 
       Scenario: Run with --format stepdefs
-      When I run `cucumber -f stepdefs --dry-run --no-publish-ad`
+      When I run `cucumber -f stepdefs --dry-run --publish-quiet`
       Then it should pass with exactly:
         """
         -----------
diff --git a/features/docs/gherkin/using_star_notation.feature b/features/docs/gherkin/using_star_notation.feature
@@ -15,7 +15,7 @@ Feature: Using star notation instead of Given/When/Then
         Scenario: S
           * I have some cukes
       """
-    When I run `cucumber features/f.feature --no-publish-ad`
+    When I run `cucumber features/f.feature --publish-quiet`
     Then the stderr should not contain anything
     And it should pass with:
       """
diff --git a/features/docs/post_configuration_hook.feature b/features/docs/post_configuration_hook.feature
@@ -17,7 +17,7 @@ Feature: Post Configuration Hook [#423]
         Scenario:
           Given a step
       """
-    When I run `cucumber features --no-publish-ad`
+    When I run `cucumber features --publish-quiet`
     Then the stderr should not contain anything
     And the output should contain NDJSON with key "uri" and value "features/simple_scenario.feature"
 
@@ -28,7 +28,7 @@ Feature: Post Configuration Hook [#423]
         config.out_stream << "AfterConfiguration hook read feature directories: #{config.feature_dirs.join(', ')}"
       end
       """
-    When I run `cucumber features --no-publish-ad`
+    When I run `cucumber features --publish-quiet`
     Then the stderr should not contain anything
     And the output should contain:
       """
diff --git a/features/docs/writing_support_code/tagged_hooks.feature b/features/docs/writing_support_code/tagged_hooks.feature
@@ -32,7 +32,7 @@ Feature: Tagged hooks
       """
 
   Scenario: omit tagged hook
-    When I run `cucumber features/f.feature:2 --no-publish-ad`
+    When I run `cucumber features/f.feature:2 --publish-quiet`
     Then it should fail with exactly:
       """
       Feature: With and without hooks
@@ -52,7 +52,7 @@ Feature: Tagged hooks
       """
 
     Scenario: omit tagged hook
-      When I run `cucumber features/f.feature:6 --no-publish-ad`
+      When I run `cucumber features/f.feature:6 --publish-quiet`
       Then it should pass with exactly:
         """
         Feature: With and without hooks
@@ -67,7 +67,7 @@ Feature: Tagged hooks
 
         """
     Scenario: Omit example hook
-      When I run `cucumber features/f.feature:14 --no-publish-ad`
+      When I run `cucumber features/f.feature:14 --publish-quiet`
       Then it should fail with exactly:
         """
         Feature: With and without hooks
diff --git a/lib/cucumber/cli/options.rb b/lib/cucumber/cli/options.rb
@@ -95,7 +95,7 @@ def parse!(args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         @args.options do |opts| # rubocop:disable Metrics/BlockLength
           opts.banner = banner
           opts.on('--publish', 'Publish a report to https://reports.cucumber.io') { @options[:formats] << publisher }
-          opts.on('--no-publish-ad', 'Don\'t print advertisement banner about publishing reports') { set_option :publish_ad, false }
+          opts.on('--publish-quiet', 'Don\'t print information banner about publishing reports') { set_option :publish_quiet }
           opts.on('-r LIBRARY|DIR', '--require LIBRARY|DIR', *require_files_msg) { |lib| require_files(lib) }
 
           opts.on('-j DIR', '--jars DIR', 'Load all the jars under DIR') { |jars| load_jars(jars) } if Cucumber::JRUBY
@@ -120,7 +120,7 @@ def parse!(args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
           opts.on('-s', '--no-source', "Don't print the file and line of the step definition with the steps.") { set_option :source, false }
           opts.on('-i', '--no-snippets', "Don't print snippets for pending steps.") { set_option :snippets, false }
           opts.on('-I', '--snippet-type TYPE', *snippet_type_msg) { |v| set_option :snippet_type, v.to_sym }
-          opts.on('-q', '--quiet', 'Alias for --no-snippets --no-source --no-duration --no-publish-ad.') { shut_up }
+          opts.on('-q', '--quiet', 'Alias for --no-snippets --no-source --no-duration --publish-quiet.') { shut_up }
           opts.on('--no-duration', "Don't print the duration at the end of the summary") { set_option :duration, false }
           opts.on('-b', '--backtrace', 'Show full backtrace for all errors.') { Cucumber.use_full_backtrace = true }
           opts.on('-S', '--[no-]strict', *strict_msg) { |setting| set_strict(setting) }
@@ -424,7 +424,7 @@ def exit_ok(text)
       end
 
       def shut_up
-        @options[:publish_ad] = false
+        @options[:publish_quiet] = true
         @options[:snippets] = false
         @options[:source] = false
         @options[:duration] = false
diff --git a/lib/cucumber/configuration.rb b/lib/cucumber/configuration.rb
@@ -62,8 +62,8 @@ def dry_run?
       @options[:dry_run]
     end
 
-    def publish_ad?
-      @options[:publish_ad]
+    def publish_quiet?
+      @options[:publish_quiet]
     end
 
     def fail_fast?
@@ -260,7 +260,7 @@ def default_options
         strict: Cucumber::Core::Test::Result::StrictConfiguration.new,
         require: [],
         dry_run: false,
-        publish_ad: true,
+        publish_quiet: false,
         fail_fast: false,
         formats: [],
         excludes: [],
diff --git a/lib/cucumber/formatter/publish_banner_printer.rb b/lib/cucumber/formatter/publish_banner_printer.rb
@@ -46,11 +46,11 @@ def display_publish_ad(io)
               ' or use the '
             ],
             [
-              pre('--no-publish-ad'),
+              pre('--publish-quiet'),
               ' option. You can also add this to your ',
               pre('cucumber.yml:')
             ],
-            [pre('default: --no-publish-ad')]
+            [pre('default: --publish-quiet')]
           ],
           io
         )
diff --git a/lib/cucumber/runtime.rb b/lib/cucumber/runtime.rb
@@ -172,7 +172,7 @@ def report
       return @report if @report
       reports = [summary_report] + formatters
       reports << fail_fast_report if @configuration.fail_fast?
-      reports << publish_banner_printer if @configuration.publish_ad?
+      reports << publish_banner_printer unless @configuration.publish_quiet?
       @report ||= Formatter::Fanout.new(reports)
     end
 
diff --git a/spec/cucumber/cli/options_spec.rb b/spec/cucumber/cli/options_spec.rb
@@ -335,7 +335,7 @@ def with_env(name, value)
             given_cucumber_yml_defined_as('foo' => '-q')
             options.parse!(%w[-p foo])
 
-            expect(options[:publish_ad]).to be false
+            expect(options[:publish_quiet]).to be true
             expect(options[:snippets]).to be false
             expect(options[:source]).to be false
             expect(options[:duration]).to be false
diff --git a/spec/cucumber/formatter/publish_banner_printer_spec.rb b/spec/cucumber/formatter/publish_banner_printer_spec.rb
@@ -34,8 +34,8 @@ module Formatter
             │ More information at https://reports.cucumber.io/docs/cucumber-ruby       │
             │                                                                          │
             │ To disable this message, specify CUCUMBER_PUBLISH_QUIET=true or use the  │
-            │ --no-publish-ad option. You can also add this to your cucumber.yml:      │
-            │ default: --no-publish-ad                                                 │
+            │ --publish-quiet option. You can also add this to your cucumber.yml:      │
+            │ default: --publish-quiet                                                 │
             └──────────────────────────────────────────────────────────────────────────┘
           BANNER
         end

Original file line number	Diff line number	Diff line change
`@@ -46,11 +46,11 @@ def display_publish_ad(io)`
`46`	`46`	`' or use the '`
`47`	`47`	`],`
`48`	`48`	`[`
`49`		`- pre('--no-publish-ad'),`
	`49`	`+ pre('--publish-quiet'),`
`50`	`50`	`' option. You can also add this to your ',`
`51`	`51`	`pre('cucumber.yml:')`
`52`	`52`	`],`
`53`		`- [pre('default: --no-publish-ad')]`
	`53`	`+ [pre('default: --publish-quiet')]`
`54`	`54`	`],`
`55`	`55`	`io`
`56`	`56`	`)`