lib/rails/generators/app_base.rb in railties-6.1.7.10 vs lib/rails/generators/app_base.rb in railties-7.0.0.alpha1
- old
+ new
@@ -28,13 +28,10 @@
desc: "Path to some #{name} template (can be a filesystem path or URL)"
class_option :database, type: :string, aliases: "-d", default: "sqlite3",
desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
- class_option :skip_gemfile, type: :boolean, default: false,
- desc: "Don't create a Gemfile"
-
class_option :skip_git, type: :boolean, aliases: "-G", default: false,
desc: "Skip .gitignore file"
class_option :skip_keeps, type: :boolean, default: false,
desc: "Skip source control .keep files"
@@ -56,30 +53,21 @@
desc: "Skip Active Job"
class_option :skip_active_storage, type: :boolean, default: false,
desc: "Skip Active Storage files"
- class_option :skip_puma, type: :boolean, aliases: "-P", default: false,
- desc: "Skip Puma related files"
-
class_option :skip_action_cable, type: :boolean, aliases: "-C", default: false,
desc: "Skip Action Cable files"
class_option :skip_sprockets, type: :boolean, aliases: "-S", default: false,
desc: "Skip Sprockets files"
- class_option :skip_spring, type: :boolean, default: false,
- desc: "Don't install Spring application preloader"
-
- class_option :skip_listen, type: :boolean, default: false,
- desc: "Don't generate configuration that depends on the listen gem"
-
class_option :skip_javascript, type: :boolean, aliases: "-J", default: name == "plugin",
desc: "Skip JavaScript files"
- class_option :skip_turbolinks, type: :boolean, default: false,
- desc: "Skip turbolinks gem"
+ class_option :skip_hotwire, type: :boolean, default: false,
+ desc: "Skip Hotwire integration"
class_option :skip_jbuilder, type: :boolean, default: false,
desc: "Skip jbuilder gem"
class_option :skip_test, type: :boolean, aliases: "-T", default: false,
@@ -95,11 +83,11 @@
desc: "Set up the #{name} with Gemfile pointing to your Rails checkout"
class_option :edge, type: :boolean, default: false,
desc: "Set up the #{name} with Gemfile pointing to Rails repository"
- class_option :master, type: :boolean, default: false,
+ class_option :main, type: :boolean, default: false, aliases: "--master",
desc: "Set up the #{name} with Gemfile pointing to Rails repository main branch"
class_option :rc, type: :string, default: nil,
desc: "Path to file containing extra configuration options for rails command"
@@ -108,53 +96,28 @@
class_option :help, type: :boolean, aliases: "-h", group: :rails,
desc: "Show this help message and quit"
end
- def initialize(positional_argv, option_argv, *)
- @argv = [*positional_argv, *option_argv]
+ def initialize(*)
@gem_filter = lambda { |gem| true }
- @extra_entries = []
super
end
private
- def gemfile_entry(name, *args) # :doc:
- options = args.extract_options!
- version = args.first
- github = options[:github]
- path = options[:path]
-
- if github
- @extra_entries << GemfileEntry.github(name, github)
- elsif path
- @extra_entries << GemfileEntry.path(name, path)
- else
- @extra_entries << GemfileEntry.version(name, version)
- end
- self
- end
-
def gemfile_entries # :doc:
[rails_gemfile_entry,
database_gemfile_entry,
web_server_gemfile_entry,
- assets_gemfile_entry,
- webpacker_gemfile_entry,
javascript_gemfile_entry,
+ hotwire_gemfile_entry,
+ css_gemfile_entry,
jbuilder_gemfile_entry,
psych_gemfile_entry,
- cable_gemfile_entry,
- @extra_entries].flatten.find_all(&@gem_filter)
+ cable_gemfile_entry].flatten.find_all(&@gem_filter)
end
- def add_gem_entry_filter # :doc:
- @gem_filter = lambda { |next_filter, entry|
- yield(entry) && next_filter.call(entry)
- }.curry[@gem_filter]
- end
-
def builder # :doc:
@builder ||= begin
builder_class = get_builder_class
builder_class.include(ActionMethods)
builder_class.new(self)
@@ -171,18 +134,13 @@
empty_directory "."
FileUtils.cd(destination_root) unless options[:pretend]
end
def apply_rails_template # :doc:
- original_argv = ARGV.dup
- ARGV.replace(@argv)
-
apply rails_template if rails_template
rescue Thor::Error, LoadError, Errno::ENOENT => e
raise Error, "The template [#{rails_template}] could not be loaded. Error: #{e}"
- ensure
- ARGV.replace(original_argv)
end
def set_default_accessors! # :doc:
self.destination_root = File.expand_path(app_path, destination_root)
self.rails_template = \
@@ -198,17 +156,15 @@
def database_gemfile_entry # :doc:
return [] if options[:skip_active_record]
gem_name, gem_version = gem_for_database
GemfileEntry.version gem_name, gem_version,
- "Use #{options[:database]} as the database for Active Record"
+ "Use #{options[:database]} as the database for Active Record"
end
def web_server_gemfile_entry # :doc:
- return [] if options[:skip_puma]
- comment = "Use Puma as the app server"
- GemfileEntry.new("puma", "~> 5.0", comment)
+ GemfileEntry.new "puma", "~> 5.0", "Use the Puma web server [https://github.com/puma/puma]"
end
def include_all_railties? # :doc:
[
options.values_at(
@@ -285,34 +241,35 @@
def version
version = super
if version.is_a?(Array)
- version.join("', '")
+ version.join('", "')
else
version
end
end
end
def rails_gemfile_entry
if options.dev?
[
- GemfileEntry.path("rails", Rails::Generators::RAILS_DEV_PATH)
+ GemfileEntry.path("rails", Rails::Generators::RAILS_DEV_PATH, "Use local checkout of Rails")
]
elsif options.edge?
+ edge_branch = Rails.gem_version.prerelease? ? "main" : [*Rails.gem_version.segments.first(2), "stable"].join("-")
[
- GemfileEntry.github("rails", "rails/rails", "6-1-stable")
+ GemfileEntry.github("rails", "rails/rails", edge_branch, "Use specific branch of Rails")
]
- elsif options.master?
+ elsif options.main?
[
- GemfileEntry.github("rails", "rails/rails", "main")
+ GemfileEntry.github("rails", "rails/rails", "main", "Use main development branch of Rails")
]
else
[GemfileEntry.version("rails",
rails_version_specifier,
- "Bundle edge Rails instead: gem 'rails', github: 'rails/rails', branch: 'main'")]
+ %(Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"))]
end
end
def rails_version_specifier(gem_version = Rails.gem_version)
if gem_version.segments.size == 3 || gem_version.release.segments.size == 3
@@ -325,34 +282,49 @@
patch = gem_version.segments[0, 3].join(".")
["~> #{patch}", ">= #{gem_version}"]
end
end
- def assets_gemfile_entry
- return [] if options[:skip_sprockets]
-
- GemfileEntry.version("sass-rails", ">= 6", "Use SCSS for stylesheets")
+ def jbuilder_gemfile_entry
+ return [] if options[:skip_jbuilder]
+ comment = "Build JSON APIs with ease [https://github.com/rails/jbuilder]"
+ GemfileEntry.new "jbuilder", "~> 2.7", comment, {}, options[:api]
end
- def webpacker_gemfile_entry
+ def javascript_gemfile_entry
return [] if options[:skip_javascript]
- GemfileEntry.version "webpacker", "~> 5.0", "Transpile app-like JavaScript. Read more: https://github.com/rails/webpacker"
+ if options[:javascript] == "importmap"
+ GemfileEntry.version("importmap-rails", ">= 0.3.4", "Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails]")
+ else
+ GemfileEntry.version "jsbundling-rails", "~> 0.1.0", "Bundle and transpile JavaScript [https://github.com/rails/jsbundling-rails]"
+ end
end
- def jbuilder_gemfile_entry
- return [] if options[:skip_jbuilder]
- comment = "Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder"
- GemfileEntry.new "jbuilder", "~> 2.7", comment, {}, options[:api]
+ def hotwire_gemfile_entry
+ return [] if options[:skip_javascript] || options[:skip_hotwire]
+
+ turbo_rails_entry =
+ GemfileEntry.version("turbo-rails", ">= 0.7.11", "Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]")
+
+ stimulus_rails_entry =
+ GemfileEntry.version("stimulus-rails", ">= 0.4.0", "Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]")
+
+ [ turbo_rails_entry, stimulus_rails_entry ]
end
- def javascript_gemfile_entry
- if options[:skip_javascript] || options[:skip_turbolinks]
- []
+ def using_node?
+ options[:javascript] && options[:javascript] != "importmap"
+ end
+
+ def css_gemfile_entry
+ return [] unless options[:css]
+
+ if !using_node? && options[:css] == "tailwind"
+ GemfileEntry.version("tailwindcss-rails", ">= 0.4.3", "Use Tailwind CSS [https://github.com/rails/tailwindcss-rails]")
else
- [ GemfileEntry.version("turbolinks", "~> 5",
- "Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks") ]
+ GemfileEntry.version("cssbundling-rails", ">= 0.1.0", "Bundle and process CSS [https://github.com/rails/cssbundling-rails]")
end
end
def psych_gemfile_entry
return [] unless defined?(Rubinius)
@@ -395,54 +367,46 @@
system(env, full_command)
end
end
def bundle_install?
- !(options[:skip_gemfile] || options[:skip_bundle] || options[:pretend])
+ !(options[:skip_bundle] || options[:pretend])
end
- def spring_install?
- !options[:skip_spring] && !options.dev? && Process.respond_to?(:fork) && !RUBY_PLATFORM.include?("cygwin")
- end
-
- def webpack_install?
- !(options[:skip_javascript] || options[:skip_webpack_install])
- end
-
def depends_on_system_test?
!(options[:skip_system_test] || options[:skip_test] || options[:api])
end
- def depend_on_listen?
- !options[:skip_listen] && os_supports_listen_out_of_the_box?
- end
-
def depend_on_bootsnap?
!options[:skip_bootsnap] && !options[:dev] && !defined?(JRUBY_VERSION)
end
- def os_supports_listen_out_of_the_box?
- /darwin|linux/.match?(RbConfig::CONFIG["host_os"])
- end
-
def run_bundle
bundle_command("install", "BUNDLE_IGNORE_MESSAGES" => "1") if bundle_install?
end
- def run_webpack
- return unless webpack_install?
+ def run_javascript
+ return if options[:skip_javascript] || !bundle_install?
- unless bundle_install?
- say <<~EXPLAIN
- Skipping `rails webpacker:install` because `bundle install` was skipped.
- To complete setup, you must run `bundle install` followed by `rails webpacker:install`.
- EXPLAIN
- return
+ case options[:javascript]
+ when "importmap" then rails_command "importmap:install"
+ when "webpack", "esbuild", "rollup" then rails_command "javascript:install:#{options[:javascript]}"
end
+ end
- rails_command "webpacker:install"
- if options[:webpack] && options[:webpack] != "webpack"
- rails_command "webpacker:install:#{options[:webpack]}"
+ def run_hotwire
+ return if options[:skip_javascript] || options[:skip_hotwire] || !bundle_install?
+
+ rails_command "turbo:install stimulus:install"
+ end
+
+ def run_css
+ return if !options[:css] || !bundle_install?
+
+ if !using_node? && options[:css] == "tailwind"
+ rails_command "tailwindcss:install"
+ else
+ rails_command "css:install:#{options[:css]}"
end
end
def generate_bundler_binstub
if bundle_install?