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

Class Method Summary collapse

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, #setup_file_error, #symlink_dest_file_to_dest_file

Class Method Details

.helpful_message ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 134

def self.helpful_message
  <<-MSG.strip_heredoc

    What to do next:

      - See the documentation on https://github.com/rails/webpacker/blob/master/docs/webpack.md
        for how to customize the default webpack configuration.

      - Include your webpack assets to your application layout.

          <%= javascript_pack_tag 'hello-world-bundle' %>

      - Run `rails s` to start the Rails server and use Webpacker's default lazy compilation.

      - Visit http://localhost:3000/hello_world and see your React On Rails app running!

      - Run bin/webpack-dev-server to start the Webpack dev server for compilation of Webpack
        assets as soon as you save. This default setup with the dev server does not work
        for server rendering

      - Alternately, you may turn off compile in config/webpacker.yml and run the foreman
        command to start the rails server and run webpack in watch mode.

          foreman start -f Procfile.dev-static

      - To turn on HMR, edit config/webpacker.yml and set HMR to true. Restart the rails server
        and bin/webpack-dev-server. Or use Procfile.dev.

      - To server render, change this line app/views/hello_world/index.html.erb to
        `prerender: true` to see server rendering (right click on page and select "view source").

          <%= react_component("HelloWorldApp", props: @hello_world_props, prerender: true) %>
  MSG
end

Instance Method Details

#add_base_gems_to_gemfile ⇒ Object 



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

def add_base_gems_to_gemfile
  gem "mini_racer", platforms: :ruby
  run "bundle"
end

#add_hello_world_route ⇒ Object 



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

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

#add_yarn_dependencies ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 78

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

  puts "Adding React dependencies"
  run "yarn add react react-dom @babel/preset-react prop-types babel-plugin-transform-react-remove-prop-types \
      babel-plugin-macros"

  puts "Adding CSS handlers"
  run "yarn add css-loader css-minimizer-webpack-plugin mini-css-extract-plugin style-loader"

  puts "Adding dev dependencies"
  run "yarn add -D @pmmmwh/react-refresh-webpack-plugin react-refresh"
end

#append_to_spec_rails_helper ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 99

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 



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

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

#copy_js_bundle_files ⇒ Object 



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

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_webpack_config ⇒ Object 



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

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/development.js
                  config/webpack/production.js
                  config/webpack/serverWebpackConfig.js
                  config/webpack/webpackConfig.js]
  config = {
    message: "// The source code including full typescript support is available at:"
  }
  base_files.each do |file|
    template("#{base_path}/#{file}.tt", file, config)
  end
end

#copy_webpacker_config ⇒ Object 



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

def copy_webpacker_config
  puts "Adding Webpacker v6 config"
  base_path = "base/base/"
  base_files = %w[config/webpacker.yml]
  base_files.each { |file| copy_file("#{base_path}#{file}", file) }
end

#create_react_directories ⇒ Object 



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

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

#print_helpful_message ⇒ Object 



169
170
171
 
# File 'lib/generators/react_on_rails/base_generator.rb', line 169

def print_helpful_message
  GeneratorMessages.add_info(self.class.helpful_message)
end