Class: ReactOnRails::Generators::BaseGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Includes:
GeneratorHelper
Defined in:
lib/generators/react_on_rails/base_generator.rb

Constant Summary collapse

CONFIGURE_RSPEC_TO_COMPILE_ASSETS = 
<<-STR.strip_heredoc
  RSpec.configure do |config|
    # Ensure that if we are running js tests, we are using latest webpack assets
    # This will use the defaults of :js and :server_rendering meta tags
    ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
STR

Instance Method Summary collapse

Methods included from GeneratorHelper

#add_documentation_reference, #copy_file_and_missing_parent_directories, #dest_dir_exists?, #dest_file_exists?, #empty_directory_with_keep_file, #keep_file, #package_json, #setup_file_error, #symlink_dest_file_to_dest_file

Instance Method Details

#add_base_gems_to_gemfile ⇒ Object 



75
76
77
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 75

def add_base_gems_to_gemfile
  run "bundle"
end

#add_hello_world_route ⇒ Object 



20
21
22
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 20

def add_hello_world_route
  route "get 'hello_world', to: 'hello_world#index'"
end

#add_js_dependencies ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 79

def add_js_dependencies
  major_minor_patch_only = /\A\d+\.\d+\.\d+\z/
  if ReactOnRails::VERSION.match?(major_minor_patch_only)
    package_json.manager.add(["react-on-rails@#{ReactOnRails::VERSION}"])
  else
    # otherwise add latest
    puts "Adding the latest react-on-rails NPM module. Double check this is correct in package.json"
    package_json.manager.add(["react-on-rails"])
  end

  puts "Adding React dependencies"
  package_json.manager.add([
                             "react",
                             "react-dom",
                             "@babel/preset-react",
                             "prop-types",
                             "babel-plugin-transform-react-remove-prop-types",
                             "babel-plugin-macros"
                           ])

  puts "Adding CSS handlers"

  package_json.manager.add(%w[
                             css-loader
                             css-minimizer-webpack-plugin
                             mini-css-extract-plugin
                             style-loader
                           ])

  puts "Adding dev dependencies"
  package_json.manager.add([
                             "@pmmmwh/react-refresh-webpack-plugin",
                             "react-refresh"
                           ], type: :dev)
end

#append_to_spec_rails_helper ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 115

def append_to_spec_rails_helper
  rails_helper = File.join(destination_root, "spec/rails_helper.rb")
  if File.exist?(rails_helper)
    add_configure_rspec_to_compile_assets(rails_helper)
  else
    spec_helper = File.join(destination_root, "spec/spec_helper.rb")
    if File.exist?(spec_helper)
      add_configure_rspec_to_compile_assets(spec_helper)
    else
      # rubocop:disable Layout/EmptyLinesAroundArguments
      GeneratorMessages.add_info(
        <<-MSG.strip_heredoc

        We did not find a spec/rails_helper.rb or spec/spec_helper.rb to add
        the React on Rails Test helper, which ensures that if we are running
        js tests, then we are using latest webpack assets. You can later add
        this to your rspec config:

        # This will use the defaults of :js and :server_rendering meta tags
        ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
        MSG
      )
      # rubocop:enable Layout/EmptyLinesAroundArguments

    end
  end
end

#copy_base_files ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 29

def copy_base_files
  base_path = "base/base/"
  base_files = %w[app/controllers/hello_world_controller.rb
                  app/views/layouts/hello_world.html.erb]
  base_templates = %w[config/initializers/react_on_rails.rb
                      Procfile.dev
                      Procfile.dev-static]
  base_files.each { |file| copy_file("#{base_path}#{file}", file) }
  base_templates.each do |file|
    template("#{base_path}/#{file}.tt", file, { packer_type: ReactOnRails::PackerUtils.packer_type })
  end
end

#copy_js_bundle_files ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 42

def copy_js_bundle_files
  base_path = "base/base/"
  base_files = %w[app/javascript/packs/server-bundle.js
                  app/javascript/bundles/HelloWorld/components/HelloWorldServer.js
                  app/javascript/bundles/HelloWorld/components/HelloWorld.module.css]
  base_files.each { |file| copy_file("#{base_path}#{file}", file) }
end

#copy_packer_config ⇒ Object 



68
69
70
71
72
73
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 68

def copy_packer_config
  puts "Adding Shakapacker #{ReactOnRails::PackerUtils.shakapacker_version} config"
  base_path = "base/base/"
  config = "config/shakapacker.yml"
  copy_file("#{base_path}#{config}", config)
end

#copy_webpack_config ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 50

def copy_webpack_config
  puts "Adding Webpack config"
  base_path = "base/base"
  base_files = %w[babel.config.js
                  config/webpack/clientWebpackConfig.js
                  config/webpack/commonWebpackConfig.js
                  config/webpack/test.js
                  config/webpack/development.js
                  config/webpack/production.js
                  config/webpack/serverWebpackConfig.js
                  config/webpack/webpack.config.js
                  config/webpack/webpackConfig.js]
  config = {
    message: "// The source code including full typescript support is available at:"
  }
  base_files.each { |file| template("#{base_path}/#{file}.tt", file, config) }
end

#create_react_directories ⇒ Object 



24
25
26
27
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 24

def create_react_directories
  dirs = %w[components]
  dirs.each { |name| empty_directory("app/javascript/bundles/HelloWorld/#{name}") }
end