66
77module CucumberRailsHelper
88 def rails_new ( options = { } )
9- validate_rails_new_success ( run_rails_new_command ( options ) )
9+ # This expectation allows us to wait until the command line monitor has output a README file (i.e. the command has completed)
10+ expect ( run_rails_new_command ( options ) ) . to have_output ( /README/ )
11+
1012 cd options [ :name ]
1113 configure_rails_gems
1214 configure_rails_requires
@@ -15,44 +17,21 @@ def rails_new(options = {})
1517 end
1618
1719 def install_cucumber_rails ( *options )
18- add_conditional_gems ( options )
19- add_rails_specific_gems
20-
21- add_gem 'cucumber' , Cucumber ::VERSION , group : :test
22- add_gem 'capybara' , Capybara ::VERSION , group : :test
23- add_gem 'rspec-expectations' , '~> 3.7' , group : :test
24- add_gem 'database_cleaner' , '>= 1.8.0' , group : :test unless options . include? ( :no_database_cleaner )
25- add_gem 'database_cleaner-active_record' , '>= 2.0.0.beta2' , group : :test if options . include? ( :database_cleaner_active_record )
26- add_gem 'factory_bot' , '>= 3.2' , group : :test unless options . include? ( :no_factory_bot )
27-
20+ add_cucumber_rails ( options )
21+ add_sqlite3
22+ add_remaining_gems ( options )
2823 bundle_install
2924 run_command_and_stop 'bundle exec rails generate cucumber:install'
3025 end
3126
3227 private
3328
34- def add_gem ( name , *args )
35- line = convert_gem_opts_to_string ( name , *args )
36- gem_regexp = /gem ["']#{ name }
37- gemfile_content = File . read ( expand_path ( 'Gemfile' ) )
38-
39- if gemfile_content . match? ( gem_regexp )
40- updated_gemfile_content = gemfile_content . gsub ( gem_regexp , line )
41- overwrite_file ( 'Gemfile' , updated_gemfile_content )
42- else
43- append_to_file ( 'Gemfile' , line )
44- end
45- end
46-
47- def remove_gem ( name )
48- content = File . read ( expand_path ( 'Gemfile' ) ) . gsub ( /^\s *gem ["']#{ name } , '' )
49- overwrite_file ( 'Gemfile' , content )
50- end
51-
52- def bundle_install
53- run_command_and_stop 'bundle config set --local without "development"'
54- run_command_and_stop "bundle config set --local path '#{ ENV . fetch ( 'GITHUB_WORKSPACE' ) } if ENV . key? ( 'GITHUB_WORKSPACE' )
55- run_command_and_stop 'bundle install --jobs 4'
29+ def run_rails_new_command ( options )
30+ options [ :name ] ||= 'test_app'
31+ flags = %w[ --skip-action-cable --skip-action-mailer --skip-active-job --skip-bootsnap --skip-bundle --skip-javascript
32+ --skip-jbuilder --skip-listen --skip-spring --skip-sprockets --skip-test-unit --skip-turbolinks --skip-active-storage ]
33+ flags += %w[ --skip-action-mailbox --skip-action-text ] if rails_equal_or_higher_than? ( '6.0' )
34+ run_command "bundle exec rails new #{ options [ :name ] } #{ flags . join ( ' ' ) } #{ options [ :args ] }
5635 end
5736
5837 def configure_rails_gems
@@ -62,8 +41,8 @@ def configure_rails_gems
6241
6342 def configure_rails_requires
6443 content = File . read ( expand_path ( 'config/application.rb' ) )
65- %w[ active_job/railtie active_storage/engine action_mailer/railtie action_mailbox/engine
66- action_text/engine action_cable/engine rails/test_unit/railtie sprockets/railtie ] . each do |require |
44+ %w[ active_job/railtie active_storage/engine action_mailer/railtie action_mailbox/engine
45+ action_text/engine action_cable/engine rails/test_unit/railtie sprockets/railtie ] . each do |require |
6746 content = content . gsub ( /^.*require ["']#{ require } \s *$/ , '' )
6847 end
6948 overwrite_file ( 'config/application.rb' , content )
@@ -75,19 +54,6 @@ def configure_rails_layout
7554 overwrite_file ( file , content )
7655 end
7756
78- def run_rails_new_command ( options )
79- options [ :name ] ||= 'test_app'
80- flags = %w[ --skip-action-cable --skip-action-mailer --skip-active-job --skip-bootsnap --skip-bundle --skip-javascript
81- --skip-jbuilder --skip-listen --skip-spring --skip-sprockets --skip-test-unit --skip-turbolinks --skip-active-storage ]
82- flags += %w[ --skip-action-mailbox --skip-action-text ] if rails_equal_or_higher_than? ( '6.0' )
83- run_command "bundle exec rails new #{ options [ :name ] } #{ flags . join ( ' ' ) } #{ options [ :args ] }
84- end
85-
86- def validate_rails_new_success ( result )
87- expect ( result ) . to have_output ( /README/ )
88- expect ( last_command_started ) . to be_successfully_executed
89- end
90-
9157 def clear_bundle_env_vars
9258 unset_bundler_env_vars
9359 delete_environment_variable 'BUNDLE_GEMFILE'
@@ -97,30 +63,63 @@ def rails_equal_or_higher_than?(version)
9763 Rails . gem_version >= Gem ::Version . new ( version )
9864 end
9965
100- def add_conditional_gems ( options )
66+ def remove_gem ( name )
67+ content = File . read ( expand_path ( 'Gemfile' ) ) . gsub ( /^\s *gem ["']#{ name } , '' )
68+ overwrite_file ( 'Gemfile' , content )
69+ end
70+
71+ def add_gem ( name , *args )
72+ line = convert_gem_opts_to_string ( name , *args )
73+ gem_regexp = /gem ["']#{ name }
74+ gemfile_content = File . read ( expand_path ( 'Gemfile' ) )
75+
76+ if gemfile_content . match? ( gem_regexp )
77+ updated_gemfile_content = gemfile_content . gsub ( gem_regexp , line )
78+ overwrite_file ( 'Gemfile' , updated_gemfile_content )
79+ else
80+ append_to_file ( 'Gemfile' , line )
81+ end
82+ end
83+
84+ def convert_gem_opts_to_string ( name , *args )
85+ options = args . last . is_a? ( Hash ) ? args . pop : { }
86+ parts = [ "'#{ name } ]
87+ parts << args . map ( &:inspect ) if args . any?
88+ parts << options . inspect [ 1 ..-2 ] if options . any?
89+ "gem #{ parts . flatten . join ( ', ' ) } \n "
90+ end
91+
92+ def add_cucumber_rails ( options )
10193 if options . include? ( :not_in_test_group )
10294 add_gem 'cucumber-rails' , path : File . expand_path ( '.' ) . to_s
10395 else
10496 add_gem 'cucumber-rails' , group : :test , require : false , path : File . expand_path ( '.' ) . to_s
10597 end
10698 end
10799
108- def add_rails_specific_gems
100+ def add_sqlite3
109101 if rails_equal_or_higher_than? ( '6.0' )
110102 add_gem 'sqlite3' , '~> 1.4'
111- add_gem 'selenium-webdriver' , '~> 4.0' , group : :test
112103 else
113104 add_gem 'sqlite3' , '~> 1.3.13'
114- add_gem 'selenium-webdriver' , '~> 3.11' , group : :test
115105 end
116106 end
117107
118- def convert_gem_opts_to_string ( name , *args )
119- options = args . last . is_a? ( Hash ) ? args . pop : { }
120- parts = [ "'#{ name } ]
121- parts << args . map ( &:inspect ) if args . any?
122- parts << options . inspect [ 1 ..-2 ] if options . any?
123- "gem #{ parts . flatten . join ( ', ' ) } \n "
108+ def add_remaining_gems ( options )
109+ add_gem 'cucumber' , Cucumber ::VERSION , group : :test
110+ add_gem 'capybara' , Capybara ::VERSION , group : :test
111+ add_gem 'database_cleaner' , '>= 2.0.0' , group : :test unless options . include? ( :no_database_cleaner )
112+ add_gem 'database_cleaner-active_record' , '>= 2.0.0' , group : :test if options . include? ( :database_cleaner_active_record )
113+ add_gem 'factory_bot' , '>= 5.0' , group : :test unless options . include? ( :no_factory_bot )
114+ add_gem 'rspec-expectations' , '~> 3.12' , group : :test
115+ add_gem 'selenium-webdriver' , '~> 4.0' , group : :test
116+ %w[ chromedriver-helper ] . each { |gem | remove_gem ( gem ) } unless rails_equal_or_higher_than? ( '6.0' )
117+ end
118+
119+ def bundle_install
120+ run_command_and_stop 'bundle config set --local without "development"'
121+ run_command_and_stop "bundle config set --local path '#{ ENV . fetch ( 'GITHUB_WORKSPACE' ) } if ENV . key? ( 'GITHUB_WORKSPACE' )
122+ run_command_and_stop 'bundle install --jobs 4'
124123 end
125124end
126125
0 commit comments