diff options
Diffstat (limited to 'railties/lib/rails/tasks')
-rw-r--r-- | railties/lib/rails/tasks/annotations.rake | 20 | ||||
-rw-r--r-- | railties/lib/rails/tasks/dev.rake | 8 | ||||
-rw-r--r-- | railties/lib/rails/tasks/engine.rake | 83 | ||||
-rw-r--r-- | railties/lib/rails/tasks/framework.rake | 56 | ||||
-rw-r--r-- | railties/lib/rails/tasks/initializers.rake | 6 | ||||
-rw-r--r-- | railties/lib/rails/tasks/log.rake | 40 | ||||
-rw-r--r-- | railties/lib/rails/tasks/middleware.rake | 7 | ||||
-rw-r--r-- | railties/lib/rails/tasks/misc.rake | 77 | ||||
-rw-r--r-- | railties/lib/rails/tasks/restart.rake | 8 | ||||
-rw-r--r-- | railties/lib/rails/tasks/routes.rake | 29 | ||||
-rw-r--r-- | railties/lib/rails/tasks/statistics.rake | 29 | ||||
-rw-r--r-- | railties/lib/rails/tasks/tmp.rake | 42 | ||||
-rw-r--r-- | railties/lib/rails/tasks/yarn.rake | 11 |
13 files changed, 416 insertions, 0 deletions
diff --git a/railties/lib/rails/tasks/annotations.rake b/railties/lib/rails/tasks/annotations.rake new file mode 100644 index 0000000000..ae427249ef --- /dev/null +++ b/railties/lib/rails/tasks/annotations.rake @@ -0,0 +1,20 @@ +require_relative "../source_annotation_extractor" + +desc "Enumerate all annotations (use notes:optimize, :fixme, :todo for focus)" +task :notes do + SourceAnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", tag: true +end + +namespace :notes do + ["OPTIMIZE", "FIXME", "TODO"].each do |annotation| + # desc "Enumerate all #{annotation} annotations" + task annotation.downcase.intern do + SourceAnnotationExtractor.enumerate annotation + end + end + + desc "Enumerate a custom annotation, specify with ANNOTATION=CUSTOM" + task :custom do + SourceAnnotationExtractor.enumerate ENV["ANNOTATION"] + end +end diff --git a/railties/lib/rails/tasks/dev.rake b/railties/lib/rails/tasks/dev.rake new file mode 100644 index 0000000000..b2447cbcfc --- /dev/null +++ b/railties/lib/rails/tasks/dev.rake @@ -0,0 +1,8 @@ +require_relative "../dev_caching" + +namespace :dev do + desc "Toggle development mode caching on/off" + task :cache do + Rails::DevCaching.enable_by_file + end +end diff --git a/railties/lib/rails/tasks/engine.rake b/railties/lib/rails/tasks/engine.rake new file mode 100644 index 0000000000..a8d67322da --- /dev/null +++ b/railties/lib/rails/tasks/engine.rake @@ -0,0 +1,83 @@ +task "load_app" do + namespace :app do + load APP_RAKEFILE + + desc "Update some initially generated files" + task update: [ "update:bin" ] + + namespace :update do + require_relative "../engine/updater" + # desc "Adds new executables to the engine bin/ directory" + task :bin do + Rails::Engine::Updater.run(:create_bin_files) + end + end + end + task environment: "app:environment" + + if !defined?(ENGINE_ROOT) || !ENGINE_ROOT + ENGINE_ROOT = find_engine_path(APP_RAKEFILE) + end +end + +def app_task(name) + task name => [:load_app, "app:db:#{name}"] +end + +namespace :db do + app_task "reset" + + desc "Migrate the database (options: VERSION=x, VERBOSE=false)." + app_task "migrate" + app_task "migrate:up" + app_task "migrate:down" + app_task "migrate:redo" + app_task "migrate:reset" + + desc "Display status of migrations" + app_task "migrate:status" + + desc "Create the database from config/database.yml for the current Rails.env (use db:create:all to create all databases in the config)" + app_task "create" + app_task "create:all" + + desc "Drops the database for the current Rails.env (use db:drop:all to drop all databases)" + app_task "drop" + app_task "drop:all" + + desc "Load fixtures into the current environment's database." + app_task "fixtures:load" + + desc "Rolls the schema back to the previous version (specify steps w/ STEP=n)." + app_task "rollback" + + desc "Create a db/schema.rb file that can be portably used against any DB supported by Active Record" + app_task "schema:dump" + + desc "Load a schema.rb file into the database" + app_task "schema:load" + + desc "Load the seed data from db/seeds.rb" + app_task "seed" + + desc "Create the database, load the schema, and initialize with the seed data (use db:reset to also drop the db first)" + app_task "setup" + + desc "Dump the database structure to an SQL file" + app_task "structure:dump" + + desc "Retrieves the current schema version number" + app_task "version" +end + +def find_engine_path(path) + return File.expand_path(Dir.pwd) if path == "/" + + if Rails::Engine.find(path) + path + else + find_engine_path(File.expand_path("..", path)) + end +end + +Rake.application.invoke_task(:load_app) diff --git a/railties/lib/rails/tasks/framework.rake b/railties/lib/rails/tasks/framework.rake new file mode 100644 index 0000000000..6c6e86d78d --- /dev/null +++ b/railties/lib/rails/tasks/framework.rake @@ -0,0 +1,56 @@ +namespace :app do + desc "Update configs and some other initially generated files (or use just update:configs or update:bin)" + task update: [ "update:configs", "update:bin", "update:upgrade_guide_info" ] + + desc "Applies the template supplied by LOCATION=(/path/to/template) or URL" + task template: :environment do + template = ENV["LOCATION"] + raise "No LOCATION value given. Please set LOCATION either as path to a file or a URL" if template.blank? + template = File.expand_path(template) if template !~ %r{\A[A-Za-z][A-Za-z0-9+\-\.]*://} + require_relative "../generators" + require_relative "../generators/rails/app/app_generator" + generator = Rails::Generators::AppGenerator.new [Rails.root], {}, destination_root: Rails.root + generator.apply template, verbose: false + end + + namespace :templates do + # desc "Copy all the templates from rails to the application directory for customization. Already existing local copies will be overwritten" + task :copy do + generators_lib = File.expand_path("../generators", __dir__) + project_templates = "#{Rails.root}/lib/templates" + + default_templates = { "erb" => %w{controller mailer scaffold}, + "rails" => %w{controller helper scaffold_controller assets} } + + default_templates.each do |type, names| + local_template_type_dir = File.join(project_templates, type) + mkdir_p local_template_type_dir, verbose: false + + names.each do |name| + dst_name = File.join(local_template_type_dir, name) + src_name = File.join(generators_lib, type, name, "templates") + cp_r src_name, dst_name, verbose: false + end + end + end + end + + namespace :update do + require_relative "../app_updater" + + # desc "Update config/boot.rb from your current rails install" + task :configs do + Rails::AppUpdater.invoke_from_app_generator :create_boot_file + Rails::AppUpdater.invoke_from_app_generator :update_config_files + end + + # desc "Adds new executables to the application bin/ directory" + task :bin do + Rails::AppUpdater.invoke_from_app_generator :update_bin_files + end + + task :upgrade_guide_info do + Rails::AppUpdater.invoke_from_app_generator :display_upgrade_guide_info + end + end +end diff --git a/railties/lib/rails/tasks/initializers.rake b/railties/lib/rails/tasks/initializers.rake new file mode 100644 index 0000000000..6522f2ae5a --- /dev/null +++ b/railties/lib/rails/tasks/initializers.rake @@ -0,0 +1,6 @@ +desc "Print out all defined initializers in the order they are invoked by Rails." +task initializers: :environment do + Rails.application.initializers.tsort_each do |initializer| + puts "#{initializer.context_class}.#{initializer.name}" + end +end diff --git a/railties/lib/rails/tasks/log.rake b/railties/lib/rails/tasks/log.rake new file mode 100644 index 0000000000..ba796845d7 --- /dev/null +++ b/railties/lib/rails/tasks/log.rake @@ -0,0 +1,40 @@ +namespace :log do + + ## + # Truncates all/specified log files + # ENV['LOGS'] + # - defaults to all environments log files i.e. 'development,test,production' + # - ENV['LOGS']=all truncates all files i.e. log/*.log + # - ENV['LOGS']='test,development' truncates only specified files + desc "Truncates all/specified *.log files in log/ to zero bytes (specify which logs with LOGS=test,development)" + task :clear do + log_files.each do |file| + clear_log_file(file) + end + end + + def log_files + if ENV["LOGS"] == "all" + FileList["log/*.log"] + elsif ENV["LOGS"] + log_files_to_truncate(ENV["LOGS"]) + else + log_files_to_truncate(all_environments.join(",")) + end + end + + def log_files_to_truncate(envs) + envs.split(",") + .map { |file| "log/#{file.strip}.log" } + .select { |file| File.exist?(file) } + end + + def clear_log_file(file) + f = File.open(file, "w") + f.close + end + + def all_environments + Dir["config/environments/*.rb"].map { |fname| File.basename(fname, ".*") } + end +end diff --git a/railties/lib/rails/tasks/middleware.rake b/railties/lib/rails/tasks/middleware.rake new file mode 100644 index 0000000000..fd98be1ea9 --- /dev/null +++ b/railties/lib/rails/tasks/middleware.rake @@ -0,0 +1,7 @@ +desc "Prints out your Rack middleware stack" +task middleware: :environment do + Rails.configuration.middleware.each do |middleware| + puts "use #{middleware.inspect}" + end + puts "run #{Rails.application.class.name}.routes" +end diff --git a/railties/lib/rails/tasks/misc.rake b/railties/lib/rails/tasks/misc.rake new file mode 100644 index 0000000000..29ea0ff804 --- /dev/null +++ b/railties/lib/rails/tasks/misc.rake @@ -0,0 +1,77 @@ +desc "Generate a cryptographically secure secret key (this is typically used to generate a secret for cookie sessions)." +task :secret do + require "securerandom" + puts SecureRandom.hex(64) +end + +desc "List versions of all Rails frameworks and the environment" +task about: :environment do + puts Rails::Info +end + +namespace :time do + desc "List all time zones, list by two-letter country code (`rails time:zones[US]`), or list by UTC offset (`rails time:zones[-8]`)" + task :zones, :country_or_offset do |t, args| + zones, offset = ActiveSupport::TimeZone.all, nil + + if country_or_offset = args[:country_or_offset] + begin + zones = ActiveSupport::TimeZone.country_zones(country_or_offset) + rescue TZInfo::InvalidCountryCode + offset = country_or_offset + end + end + + build_time_zone_list zones, offset + end + + namespace :zones do + # desc 'Displays all time zones, also available: time:zones:us, time:zones:local -- filter with OFFSET parameter, e.g., OFFSET=-6' + task :all do + build_time_zone_list ActiveSupport::TimeZone.all + end + + # desc 'Displays names of US time zones recognized by the Rails TimeZone class, grouped by offset. Results can be filtered with optional OFFSET parameter, e.g., OFFSET=-6' + task :us do + build_time_zone_list ActiveSupport::TimeZone.us_zones + end + + # desc 'Displays names of time zones recognized by the Rails TimeZone class with the same offset as the system local time' + task :local do + require "active_support" + require "active_support/time" + + jan_offset = Time.now.beginning_of_year.utc_offset + jul_offset = Time.now.beginning_of_year.change(month: 7).utc_offset + offset = jan_offset < jul_offset ? jan_offset : jul_offset + + build_time_zone_list(ActiveSupport::TimeZone.all, offset) + end + + # to find UTC -06:00 zones, OFFSET can be set to either -6, -6:00 or 21600 + def build_time_zone_list(zones, offset = ENV["OFFSET"]) + require "active_support" + require "active_support/time" + if offset + offset = if offset.to_s.match(/(\+|-)?(\d+):(\d+)/) + sign = $1 == "-" ? -1 : 1 + hours, minutes = $2.to_f, $3.to_f + ((hours * 3600) + (minutes.to_f * 60)) * sign + elsif offset.to_f.abs <= 13 + offset.to_f * 3600 + else + offset.to_f + end + end + previous_offset = nil + zones.each do |zone| + if offset.nil? || offset == zone.utc_offset + puts "\n* UTC #{zone.formatted_offset} *" unless zone.utc_offset == previous_offset + puts zone.name + previous_offset = zone.utc_offset + end + end + puts "\n" + end + end +end diff --git a/railties/lib/rails/tasks/restart.rake b/railties/lib/rails/tasks/restart.rake new file mode 100644 index 0000000000..03177d9954 --- /dev/null +++ b/railties/lib/rails/tasks/restart.rake @@ -0,0 +1,8 @@ +desc "Restart app by touching tmp/restart.txt" +task :restart do + verbose(false) do + mkdir_p "tmp" + touch "tmp/restart.txt" + rm_f "tmp/pids/server.pid" + end +end diff --git a/railties/lib/rails/tasks/routes.rake b/railties/lib/rails/tasks/routes.rake new file mode 100644 index 0000000000..215fb2ceb5 --- /dev/null +++ b/railties/lib/rails/tasks/routes.rake @@ -0,0 +1,29 @@ +require "optparse" + +desc "Print out all defined routes in match order, with names. Target specific controller with -c option, or grep routes using -g option" +task routes: :environment do + all_routes = Rails.application.routes.routes + require "action_dispatch/routing/inspector" + inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes) + + routes_filter = nil + + OptionParser.new do |opts| + opts.banner = "Usage: rails routes [options]" + + Rake.application.standard_rake_options.each { |args| opts.on(*args) } + + opts.on("-c CONTROLLER") do |controller| + routes_filter = { controller: controller } + end + + opts.on("-g PATTERN") do |pattern| + routes_filter = pattern + end + + end.parse!(ARGV.reject { |x| x == "routes" }) + + puts inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, routes_filter) + + exit 0 # ensure extra arguments aren't interpreted as Rake tasks +end diff --git a/railties/lib/rails/tasks/statistics.rake b/railties/lib/rails/tasks/statistics.rake new file mode 100644 index 0000000000..0670050d34 --- /dev/null +++ b/railties/lib/rails/tasks/statistics.rake @@ -0,0 +1,29 @@ +# While global constants are bad, many 3rd party tools depend on this one (e.g +# rspec-rails & cucumber-rails). So a deprecation warning is needed if we want +# to remove it. +STATS_DIRECTORIES = [ + %w(Controllers app/controllers), + %w(Helpers app/helpers), + %w(Jobs app/jobs), + %w(Models app/models), + %w(Mailers app/mailers), + %w(Channels app/channels), + %w(JavaScripts app/assets/javascripts), + %w(Libraries lib/), + %w(APIs app/apis), + %w(Controller\ tests test/controllers), + %w(Helper\ tests test/helpers), + %w(Model\ tests test/models), + %w(Mailer\ tests test/mailers), + %w(Job\ tests test/jobs), + %w(Integration\ tests test/integration), + %w(System\ tests test/system), +].collect do |name, dir| + [ name, "#{File.dirname(Rake.application.rakefile_location)}/#{dir}" ] +end.select { |name, dir| File.directory?(dir) } + +desc "Report code statistics (KLOCs, etc) from the application or engine" +task :stats do + require_relative "../code_statistics" + CodeStatistics.new(*STATS_DIRECTORIES).to_s +end diff --git a/railties/lib/rails/tasks/tmp.rake b/railties/lib/rails/tasks/tmp.rake new file mode 100644 index 0000000000..3d8ced1bf3 --- /dev/null +++ b/railties/lib/rails/tasks/tmp.rake @@ -0,0 +1,42 @@ +namespace :tmp do + desc "Clear cache, socket and screenshot files from tmp/ (narrow w/ tmp:cache:clear, tmp:sockets:clear, tmp:screenshots:clear)" + task clear: ["tmp:cache:clear", "tmp:sockets:clear", "tmp:screenshots:clear"] + + tmp_dirs = [ "tmp/cache", + "tmp/sockets", + "tmp/pids", + "tmp/cache/assets" ] + + tmp_dirs.each { |d| directory d } + + desc "Creates tmp directories for cache, sockets, and pids" + task create: tmp_dirs + + namespace :cache do + # desc "Clears all files and directories in tmp/cache" + task :clear do + rm_rf Dir["tmp/cache/[^.]*"], verbose: false + end + end + + namespace :sockets do + # desc "Clears all files in tmp/sockets" + task :clear do + rm Dir["tmp/sockets/[^.]*"], verbose: false + end + end + + namespace :pids do + # desc "Clears all files in tmp/pids" + task :clear do + rm Dir["tmp/pids/[^.]*"], verbose: false + end + end + + namespace :screenshots do + # desc "Clears all files in tmp/screenshots" + task :clear do + rm Dir["tmp/screenshots/[^.]*"], verbose: false + end + end +end diff --git a/railties/lib/rails/tasks/yarn.rake b/railties/lib/rails/tasks/yarn.rake new file mode 100644 index 0000000000..6cb19b7282 --- /dev/null +++ b/railties/lib/rails/tasks/yarn.rake @@ -0,0 +1,11 @@ +namespace :yarn do + desc "Install all JavaScript dependencies as specified via Yarn" + task :install do + system("./bin/yarn install --no-progress --production") + end +end + +# Run Yarn prior to Sprockets assets precompilation, so dependencies are available for use. +if Rake::Task.task_defined?("assets:precompile") + Rake::Task["assets:precompile"].enhance [ "yarn:install" ] +end |