Comment rechercher un fichier texte pour un modèle et de le remplacer par une valeur donnée

Avertissement: Cette approche est un naïf illustration de ruby capacités, et non pas une production de qualité de la solution pour le remplacement de chaînes de caractères dans les fichiers. Il est sujet à divers scénarios d'échec, tel que perte de données en cas de crash, interrompre, ou le disque est plein. Ce code n'est pas adapté pour rien au-delà d'un moyen rapide d'un script où toutes les données sont sauvegardées. Pour cette raison, ne pas copier ce code dans vos programmes.

Voici un petit court chemin pour le faire.

file_names = ['foo.txt', 'bar.txt']

file_names.each do |file_name|
  text = File.read(file_name)
  new_contents = text.gsub(/search_regexp/, "replacement string")

  # To merely print the contents of the file, use:
  puts new_contents

  # To write changes to the file, use:
  File.open(file_name, "w") {|file| file.puts new_contents }
end

Gardez à l'esprit que, lorsque vous faites cela, le système de fichiers est peut-être hors de l'espace et vous pouvez créer un fichier de longueur nulle. C'est catastrophique, si vous êtes en train de faire quelque chose comme de l'écriture /etc/passwd fichiers tant que partie du système de gestion de la configuration.

[ EDIT: a noter que l'édition de fichier comme dans l'acceptation de réponse sera toujours tronquer le fichier et copiez le nouveau fichier de manière séquentielle. Il y aura toujours une condition de course où le cumul des lecteurs verront un fichier tronqué. Si le processus est interrompu pour une raison quelconque (ctrl-c, OOM killer, plantage du système, panne de courant, etc) au cours de l'écriture, puis le fichier tronqué également être à gauche, qui peut être catastrophique. C'est le genre de dataloss scénario où les développeurs DOIVENT considérer, car il va se passer. Pour cette raison, je pense que l'on a accepté la réponse devrait probablement pas la accepté de répondre. Au minimum d'écrire dans un fichier temporaire et déplacer/renommer le fichier en place comme la "simplicité" de la solution à la fin de cette réponse.]

Vous avez besoin d'utiliser un algorithme qui:

1. lit l'ancien fichier et écrit dans le nouveau fichier. (Vous devez être prudent au sujet de qui sucent ensemble de fichiers en mémoire).

2. explicitement ferme le nouveau fichier temporaire, qui est l'endroit où vous pouvez lancer une exception parce que les tampons de fichier ne peuvent pas être écrites sur le disque, car il n'y a pas d'espace. (L'intercepter et de le nettoyage le fichier temporaire si vous le souhaitez, mais vous avez besoin de renvoyer quelque chose ou ne parviennent pas assez dur à ce point.

3. fixe les autorisations de fichier et de modes sur le nouveau fichier.

4. renomme le fichier et le place en place.

Avec les systèmes de fichiers ext3 vous avez la garantie que les métadonnées écrire pour déplacer le fichier en place ne sont réarrangées par le système de fichiers et les écrits avant de les tampons de données pour le nouveau fichier sont écrites, ce qui devrait réussissent ou échouent. Le système de fichiers ext4 a également été patché pour soutenir ce genre de comportement. Si vous êtes vraiment paranoïaque, vous devriez appeler le fdatasync() appel système comme une étape 3.5 avant de déplacer le fichier en place.

Indépendamment de la langue, c'est la meilleure pratique. Dans les langues où l'appelant close() ne pas lever une exception (Perl ou C) vous devez explicitement vérifier le retour de close() et de lever une exception en cas d'échec.

La suggestion ci-dessus pour simplement slurp le fichier dans la mémoire, de la manipuler et de l'écrire dans le fichier seront garantis pour produire des fichiers de longueur nulle sur un système de fichiers complet. Vous devez toujours utilisation FileUtils.mv pour déplacer un écrit de fichier temporaire en place.

Une dernière considération est l'emplacement du fichier temporaire. Si vous ouvrez un fichier dans /tmp ensuite, vous devez tenir compte de quelques problèmes:

• Si /tmp est monté sur un système de fichier différent, vous pouvez exécuter /tmp de l'espace avant d'avoir écrit le fichier qui serait autrement d'être déployée à la destination de l'ancien fichier.

• Probablement plus important encore, lorsque vous essayez de mv le fichier sur un appareil mont vous de manière transparente converties en cp comportement. L'ancien fichier sera ouvert, les anciens fichiers de l'inode sera préservé et rouvert et le contenu du fichier sera copié. Ce n'est probablement pas ce que vous voulez, et vous pouvez exécuter en "fichier texte occupé" erreurs si vous essayez de modifier le contenu d'un fichier. Ceci est également défait le but de l'utilisation du système de fichiers mv commandes et vous pouvez exécuter le système de fichiers de destination de l'espace avec seulement partiellement écrite fichier.

  Également, cela n'a rien à voir avec le Rubis de la mise en œuvre. Le système mv et cp commandes comportent de la même façon.

Ce qui est plus préférable d'ouvrir un fichier temporaire dans le même répertoire que l'ancien fichier. Cela garantit qu'il n'y aura pas de cross-device déplacer les problèmes. Le mv lui-même ne doit jamais échouer, et vous devriez toujours obtenir un complet et untruncated fichier. Toute défaillance, tels que l'appareil de l'espace, des erreurs d'autorisation, etc., devrait être rencontrés lors de l'écriture du fichier temporaire sur.

Les seuls inconvénients de l'approche de la création du fichier temporaire dans le répertoire de destination sont:

• parfois, vous pourriez ne pas être en mesure d'ouvrir un fichier temporaire, comme si vous essayez de modifier un fichier dans /proc par exemple. Pour cette raison, vous pourriez tomber en arrière et essayer de /tmp si l'ouverture du fichier dans le répertoire de destination échoue.
• vous devez avoir suffisamment d'espace sur la partition de destination dans le but de tenir à la fois l'ancien et le nouveau fichier. Toutefois, si vous n'avez pas suffisamment d'espace pour contenir à la fois des copies, alors vous êtes probablement à court d'espace disque et le risque réel de l'écriture d'un fichier tronqué est beaucoup plus élevé, donc je dirais que c'est une très mauvaise compromis à l'extérieur de certaines extrêmement étroite (et bien suivis) des cas limites.

Voici un code qui implémente le plein algorithme (windows code n'est pas testé et inachevé):

#!/usr/bin/env ruby

require 'tempfile'

def file_edit(filename, regexp, replacement)
  tempdir = File.dirname(filename)
  tempprefix = File.basename(filename)
  tempprefix.prepend('.') unless RUBY_PLATFORM =~ /mswin|mingw|windows/
  tempfile =
    begin
      Tempfile.new(tempprefix, tempdir)
    rescue
      Tempfile.new(tempprefix)
    end
  File.open(filename).each do |line|
    tempfile.puts line.gsub(regexp, replacement)
  end
  tempfile.fdatasync unless RUBY_PLATFORM =~ /mswin|mingw|windows/
  tempfile.close
  unless RUBY_PLATFORM =~ /mswin|mingw|windows/
    stat = File.stat(filename)
    FileUtils.chown stat.uid, stat.gid, tempfile.path
    FileUtils.chmod stat.mode, tempfile.path
  else
    # FIXME: apply perms on windows
  end
  FileUtils.mv tempfile.path, filename
end

file_edit('/tmp/foo', /foo/, "baz")

Et ici est un peu plus version ne vous inquiétez pas à propos de tous les possibles cas de bord (si vous êtes sous Unix et ne se soucient pas de l'écriture dans /proc):

#!/usr/bin/env ruby

require 'tempfile'

def file_edit(filename, regexp, replacement)
  Tempfile.open(".#{File.basename(filename)}", File.dirname(filename)) do |tempfile|
    File.open(filename).each do |line|
      tempfile.puts line.gsub(regexp, replacement)
    end
    tempfile.fdatasync
    tempfile.close
    stat = File.stat(filename)
    FileUtils.chown stat.uid, stat.gid, tempfile.path
    FileUtils.chmod stat.mode, tempfile.path
    FileUtils.mv tempfile.path, filename
  end
end

file_edit('/tmp/foo', /foo/, "baz")

Vraiment le cas simple d'utilisation, lorsque vous n'avez pas de soins sur les autorisations de système de fichiers (vous n'êtes pas en cours d'exécution en tant que root, ou vous êtes en cours d'exécution en tant que root et le fichier est à la racine de la propriété):

#!/usr/bin/env ruby

require 'tempfile'

def file_edit(filename, regexp, replacement)
  Tempfile.open(".#{File.basename(filename)}", File.dirname(filename)) do |tempfile|
    File.open(filename).each do |line|
      tempfile.puts line.gsub(regexp, replacement)
    end
    tempfile.close
    FileUtils.mv tempfile.path, filename
  end
end

file_edit('/tmp/foo', /foo/, "baz")

TL;DR: Qui doit être utilisé au lieu de la accepté de répondre à un minimum, dans tous les cas, afin d'assurer la mise à jour est atomique et de lecteurs simultanés ne verrez pas les fichiers tronqués. Comme je l'ai mentionné ci-dessus, la création du fichier temporaire dans le même répertoire que le fichier modifié est important afin d'éviter la croix appareil mv opérations traduites en cp opérations si /tmp est monté sur un appareil différent. L'appel de fdatasync est une couche supplémentaire de la paranoïa, mais il va subir une dégradation des performances, j'ai donc omis de cet exemple, car il n'est pas couramment pratiqué.

Une autre approche est l'utilisation directe de l'édition à l'intérieur de Ruby (et non à partir de la ligne de commande):

#!/usr/bin/ruby

def inplace_edit(file, bak, &block)
    old_stdout = $stdout
    argf = ARGF.clone

    argf.argv.replace [file]
    argf.inplace_mode = bak
    argf.each_line do |line|
        yield line
    end
    argf.close

    $stdout = old_stdout
end

inplace_edit 'test.txt', '.bak' do |line|
    line = line.gsub(/search1/,"replace1")
    line = line.gsub(/search2/,"replace2")
    print line unless line.match(/something/)
end

Si vous ne voulez pas créer une sauvegarde, puis le changement".bak " pour ".

Cela fonctionne pour moi:

filename = "foo"
text = File.read(filename) 
content = text.gsub(/search_regexp/, "replacestring")
File.open(filename, "w") { |file| file << content }

Si vous avez besoin de faire des substitutions à travers la ligne des frontières, alors à l'aide de ruby -pi -e ne fonctionnera pas parce que les p processus d'une ligne à la fois. Au lieu de cela, je recommande ce qui suit, même si elle peut échouer avec un multi-GO fichier:

ruby -e "file='translation.ja.yml'; IO.write(file, (IO.read(file).gsub(/\s+'$/, %q('))))"

L'est à la recherche d'espace blanc (y compris éventuellement les nouvelles lignes) à la suite d'une citation, auquel cas il se débarrasse de l'espace. Le %q(')est juste une façon élégante de citer le caractère de devis.