Refactor/project initializer (#1799)

* Tidy up project initializer

* Move deprecator to core top level file

* Fix up specs for the project initializer workflow

* Fix rubocop complaint about stderr.puts

* AF: RSpec/MetadataStyle

* Remove unrequired metadata tags

* Fix up rubocop and add clarity regarding CCK testing purpose

* Fix up deprecation spec

* Rubocop fixes for deprecate class method spec

Author: luke-hill

compatibility/cck_spec.rb

@@ -5,7 +5,12 @@
 
 require 'cck/examples'
 
-describe 'Cucumber Compatibility Kit', type: :feature, cck: true do
+# This is the implementation of the CCK testing for cucumber-ruby
+# It will run each example from the CCK that is of type "gherkin" (As "markdown" examples aren't implemented in ruby)
+#
+# All step definition and required supporting logic is contained here, the CCK gem proper contains the source of truth
+# of the "golden" NDJSON files and attachments / miscellaneous files
+describe CCK, :cck do
   let(:cucumber_command) { 'bundle exec cucumber --publish-quiet --profile none --format message' }
 
   CCK::Examples.gherkin.each do |example_name|

lib/cucumber.rb

@@ -13,6 +13,14 @@ class << self
     attr_accessor :wants_to_quit
     attr_reader :use_legacy_autoloader
 
+    def deprecate(message, method, remove_after_version)
+      Kernel.warn(
+        "\nWARNING: #{method} is deprecated" \
+          " and will be removed after version #{remove_after_version}. #{message}.\n" \
+          "(Called from #{caller(3..3).first})"
+      )
+    end
+
     def logger
       return @log if @log
 

lib/cucumber/deprecate.rb

@@ -4,7 +4,6 @@
 require 'cucumber/cucumber_expressions/cucumber_expression'
 require 'cucumber/cucumber_expressions/regular_expression'
 require 'cucumber/cucumber_expressions/cucumber_expression_generator'
-require 'cucumber/deprecate'
 require 'cucumber/glue/dsl'
 require 'cucumber/glue/snippet'
 require 'cucumber/glue/hook'

lib/cucumber/glue/registry_and_more.rb

@@ -4,7 +4,6 @@
 require 'cucumber/gherkin/data_table_parser'
 require 'cucumber/gherkin/formatter/escaping'
 require 'cucumber/multiline_argument/data_table/diff_matrices'
-require 'cucumber/deprecate'
 
 module Cucumber
   module MultilineArgument

lib/cucumber/multiline_argument/data_table.rb

@@ -12,33 +12,21 @@ def run
 
     private
 
-    def create_directory(dir_name)
-      create_directory_or_file dir_name, true
+    def create_directory(directory_name)
+      create_directory_or_file(directory_name, command: :mkdir_p)
     end
 
-    def create_file(file_name)
-      create_directory_or_file file_name, false
+    def create_file(filename)
+      create_directory_or_file(filename, command: :touch)
     end
 
-    def create_directory_or_file(file_name, directory)
-      file_type = if directory
-                    :mkdir_p
-                  else
-                    :touch
-                  end
-
-      report_exists(file_name) || return if File.exist?(file_name)
-
-      report_creating(file_name)
-      FileUtils.send file_type, file_name
-    end
-
-    def report_exists(file)
-      puts "   exist   #{file}"
-    end
-
-    def report_creating(file)
-      puts "  create   #{file}"
+    def create_directory_or_file(name, command:)
+      if File.exist?(name)
+        puts "#{name} already exists"
+      else
+        puts "creating #{name}"
+        FileUtils.send(command, name)
+      end
     end
   end
 end

lib/cucumber/project_initializer.rb

@@ -2,7 +2,6 @@
 
 require 'fileutils'
 require 'cucumber/configuration'
-require 'cucumber/deprecate'
 require 'cucumber/load_path'
 require 'cucumber/formatter/duration'
 require 'cucumber/file_specs'

lib/cucumber/runtime.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+describe Cucumber do
+  describe '.deprecate' do
+    it 'outputs a message to $stderr' do
+      allow(Kernel).to receive(:warn)
+
+      expect(Kernel).to receive(:warn).with(
+        a_string_including('WARNING: #some_method is deprecated and will be removed after version 1.0.0. Use #some_other_method instead.')
+      )
+
+      described_class.deprecate('Use #some_other_method instead', '#some_method', '1.0.0')
+    end
+  end
+end

spec/cucumber/cucumber_spec.rb

@@ -1,86 +1,87 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-require 'tmpdir'
+describe Cucumber::ProjectInitializer do
+  let(:command_line_config) { described_class.new }
 
-module Cucumber
-  describe ProjectInitializer, isolated_home: true do
-    let(:command_line_config) { described_class.new }
+  before { allow(command_line_config).to receive(:puts) }
 
-    before do
-      allow(command_line_config).to receive(:puts)
+  context 'when there are no existing files' do
+    around(:example) do |example|
+      dir = Dir.mktmpdir
+      original_dir = Dir.pwd
+      begin
+        FileUtils.cd(dir)
+        example.call
+      ensure
+        FileUtils.cd(original_dir)
+        FileUtils.rm_rf(dir)
+      end
     end
 
-    context 'when there are no existing files' do
-      around(:example) do |example|
-        dir = Dir.mktmpdir
-        original_dir = Dir.pwd
-        begin
-          FileUtils.cd dir
-          example.call
-        ensure
-          FileUtils.cd original_dir
-          FileUtils.rm_rf dir
-        end
-      end
+    it 'still creates a features directory' do
+      expect(command_line_config).to receive(:puts).with('creating features')
 
-      it 'still creates a features directory' do
-        expect(command_line_config).to receive(:puts).with(/^\s+create\s+features$/)
-        command_line_config.run
-      end
+      command_line_config.run
+    end
 
-      it 'still creates a step_definitions directory' do
-        expect(command_line_config).to receive(:puts).with(/^\s+create\s+features\/step_definitions$/)
-        command_line_config.run
-      end
+    it 'still creates a step_definitions directory' do
+      expect(command_line_config).to receive(:puts).with('creating features/step_definitions')
 
-      it 'still creates a support directory' do
-        expect(command_line_config).to receive(:puts).with(/^\s+create\s+features\/support$/)
-        command_line_config.run
-      end
+      command_line_config.run
+    end
 
-      it 'still creates an env.rb file' do
-        expect(command_line_config).to receive(:puts).with(/^\s+create\s+features\/support\/env.rb$/)
-        command_line_config.run
-      end
+    it 'still creates a support directory' do
+      expect(command_line_config).to receive(:puts).with('creating features/support')
+
+      command_line_config.run
     end
 
-    context 'when there are existing files' do
-      around(:example) do |example|
-        dir = Dir.mktmpdir
-        FileUtils.mkdir_p "#{dir}/features"
-        FileUtils.mkdir_p "#{dir}/features/step_definitions"
-        FileUtils.mkdir_p "#{dir}/features/support"
-        FileUtils.touch "#{dir}/features/support/env.rb"
-        original_dir = Dir.pwd
-        begin
-          FileUtils.cd dir
-          example.call
-        ensure
-          FileUtils.cd original_dir
-          FileUtils.rm_rf dir
-        end
-      end
+    it 'still creates an env.rb file' do
+      expect(command_line_config).to receive(:puts).with('creating features/support/env.rb')
 
-      it 'does not create a features directory' do
-        expect(command_line_config).to receive(:puts).with(/^\s+exist\s+features$/)
-        command_line_config.run
-      end
+      command_line_config.run
+    end
+  end
 
-      it 'does not create a step_definitions directory' do
-        expect(command_line_config).to receive(:puts).with(/^\s+exist\s+features\/step_definitions$/)
-        command_line_config.run
+  context 'when there are existing files' do
+    around(:example) do |example|
+      dir = Dir.mktmpdir
+      FileUtils.mkdir_p("#{dir}/features")
+      FileUtils.mkdir_p("#{dir}/features/step_definitions")
+      FileUtils.mkdir_p("#{dir}/features/support")
+      FileUtils.touch("#{dir}/features/support/env.rb")
+      original_dir = Dir.pwd
+      begin
+        FileUtils.cd(dir)
+        example.call
+      ensure
+        FileUtils.cd(original_dir)
+        FileUtils.rm_rf(dir)
       end
+    end
 
-      it 'does not create a support directory' do
-        expect(command_line_config).to receive(:puts).with(/^\s+exist\s+features\/support$/)
-        command_line_config.run
-      end
+    it 'does not create a features directory' do
+      expect(command_line_config).to receive(:puts).with('features already exists')
 
-      it 'does not create an env.rb file' do
-        expect(command_line_config).to receive(:puts).with(/^\s+exist\s+features\/support\/env.rb$/)
-        command_line_config.run
-      end
+      command_line_config.run
+    end
+
+    it 'does not create a step_definitions directory' do
+      expect(command_line_config).to receive(:puts).with('features/step_definitions already exists')
+
+      command_line_config.run
+    end
+
+    it 'does not create a support directory' do
+      expect(command_line_config).to receive(:puts).with('features/support already exists')
+
+      command_line_config.run
+    end
+
+    it 'does not create an env.rb file' do
+      expect(command_line_config).to receive(:puts).with('features/support/env.rb already exists')
+
+      command_line_config.run
     end
   end
 end