inplace 1.2.2 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ccac19271e8549ee042dd4798133409441b8f07edc3b46590be41243c8422a1b
+  data.tar.gz: d67e327764fefa4f51cdb7136d61e9fe4a39196798104824ea38c15541296aaa
+SHA512:
+  metadata.gz: 6cb70cbe001f36c31feaacea51a9c3f1511a1d70f15ef9ca867a36a545446e68426b94222e34baf815a9beca0ab54af41fd219b93dbabc9a6ca58fb475bb9e44
+  data.tar.gz: fbcfd3ff70a729bf4bc1f19740c50a7083a9851a6cce84f28db14ed43e88aeea18f792705fb15ec7727d7ee1336c4b0211ed51d316ad20c9e73186ef9965e1d4

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2004, 2005, 2006, 2007, 2008, 2012 Akinori MUSHA
+Copyright (c) 2004-2023 Akinori MUSHA
 
 All rights reserved.
 

data/README.md

@@ -8,9 +8,8 @@ inplace -- edits files in-place through given filter commands
 ## SYNOPSIS
 
 ```
-inplace [-DLfinstvz] [-b suffix] -e commandline [[-e commandline] ...]
-        [file ...]
-inplace [-DLfinstvz] [-b suffix] commandline [file ...]
+inplace [-DLfinstvz] [-b SUFFIX]
+        [[-e] "COMMANDLINE"] [-E COMMAND ... --] [file ...]
 ```
 
 ## DESCRIPTION
@@ -24,8 +23,8 @@ Inode numbers will change by default, but there is a `-i` option with
 which given the inode number of each edited file will be preserved.
 
 As for filter commands, a single command may be specified as the first
-argument to inplace.  To pass many filter commands, specify each
-followed by the `-e` option.
+argument to inplace.  To pass many filter commands, use `-e` or `-E`
+option.
 
 There are some cases where inplace does not replace a file, such as
 when:
@@ -68,6 +67,8 @@ The following command line arguments are supported:
 
 *   `-e COMMANDLINE`
 *   `--execute COMMANDLINE`
+*   `-E COMMAND ... --` / `-E<TERM> COMMAND ... <TERM>`
+*   `--execute-args COMMAND ... --` / `--execute-args=<TERM> COMMAND ... <TERM>`
 
     Specify a filter command line to run for each file in which the
     following placeholders can be used:
@@ -103,8 +104,8 @@ The following command line arguments are supported:
     that file name aware programs can play nicely with it.
 
     Instead of specifying a whole command line, you can use a command
-    alias defined in a configuration file, `~/.inplace`.  See the
-    FILES section for the file format.
+    alias defined in a configuration file, `~/.config/inplace/config`
+    or `~/.inplace`.  See the FILES section for the file format.
 
     This option can be specified many times, and they will be executed
     in sequence.  A file is only replaced if all of them succeeds.
@@ -174,24 +175,23 @@ The following command line arguments are supported:
 
 *   Perform in-place charset conversion and newline code conversion:
 
-        inplace -e 'iconv -f EUC-JP -t UTF-8' -e 'perl -pe "s/$/\\r/"'
-        file1 file2 file3
+        inplace -E iconv -f EUC-JP -t UTF-8 -- -E perl -pe 's/$/\r/' -- file1 file2 file3
 
 *   Process image files taking backup files:
 
-        inplace -b.orig 'convert -rotate 270 -resize 50%% %1 %2' *.jpg
+        inplace -b.orig -E convert -rotate 270 -resize 50%% %1 %2 -- *.jpg
 
 *   Perform a mass MP3 tag modification without changing timestamps:
 
-        find mp3/Some_Artist -name '*.mp3' -print0 | xargs -0 inplace
-        -te 'mp3info -a "Some Artist" -g "Progressive Rock" %1'
+        find mp3/Some_Artist -name '*.mp3' -print0 | \
+          xargs -0 inplace -tE mp3info -a "Some Artist" -g "Progressive Rock" %1 --
 
     As you see above, inplace makes a nice combo with find(1) and
     `xargs(1)`.
 
 ## FILES
 
-*   `~/.inplace`
+*   `~/.config/inplace/config` or `~/.inplace`
 
     The configuration file, which syntax is described as follows:
 

data/Rakefile

@@ -6,3 +6,10 @@ task :default => :test
 task :test do
   sh 'test/test.sh'
 end
+
+task :tarball do
+  gemspec = Bundler::GemHelper.gemspec
+  sh <<-'EOF' % [gemspec.name, gemspec.version.to_s]
+git archive --format=tar --prefix=%1$s-%2$s/ v%2$s | bzip2 -9c > %1$s-%2$s.tar.bz2
+  EOF
+end

data/inplace.gemspec

@@ -10,6 +10,7 @@ Inplace(1) is a command line utility that edits files in-place through
 given filter commands.  e.g. inplace 'sort' file1 file2 file3
   EOS
   gem.homepage      = "https://github.com/knu/inplace"
+  gem.license       = "2-clause BSDL"
 
   gem.files         = `git ls-files`.split("\n")
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/inplace.rb

@@ -3,7 +3,7 @@
 #
 # inplace.rb - edits files in-place through given filter commands
 #
-# Copyright (c) 2004, 2005, 2006, 2007, 2008, 2012 Akinori MUSHA
+# Copyright (c) 2004-2023 Akinori MUSHA
 #
 # All rights reserved.
 #
@@ -29,18 +29,14 @@
 # SUCH DAMAGE.
 #
 
-if RUBY_VERSION < "1.8.2"
-  STDERR.puts "Ruby 1.8.2 or later is required."
-  exit 255
-end
-
 module Inplace
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end
 
 MYNAME = File.basename($0)
 
 require "optparse"
+require "shellwords"
 
 def main(argv)
   $uninterruptible = $interrupt = false
@@ -56,8 +52,8 @@ def main(argv)
   }
 
   usage = <<-"EOF"
-usage: #{MYNAME} [-Lfinstvz] [-b SUFFIX] COMMANDLINE [file ...]
-       #{MYNAME} [-Lfinstvz] [-b SUFFIX] [-e COMMANDLINE] [file ...]
+usage: #{MYNAME} [-Lfinstvz] [-b SUFFIX]
+                 [-e "COMMANDLINE"] [-E COMMAND ... --] [file ...]
   EOF
 
   banner = <<-"EOF"
@@ -71,8 +67,18 @@ Edits files in-place through given filter commands.
   filters = []
 
   $config = Inplace::Config.new
-  file = File.expand_path("~/.inplace")
-  $config.load(file) if File.exist?(file)
+  [
+    File.join(
+      ENV.fetch("XDG_CONFIG_HOME") { File.expand_path("~/.config") },
+      "inplace/config"
+    ),
+    File.expand_path("~/.inplace"),
+  ].each do |file|
+    if File.exist?(file)
+      $config.load(file)
+      break
+    end
+  end
 
   opts = OptionParser.new(banner, 24) { |opts|
     nextline = "\n" << opts.summary_indent << " " * opts.summary_width << " "
@@ -113,6 +119,29 @@ Edits files in-place through given filter commands.
       |s| filters << FileFilter.new($config.expand_alias(s))
     }
 
+    opts.on("-E", "--execute-args[=TERM]",
+      "Run COMMAND with all following arguments until TERM" << nextline <<
+      "(default: '--') is encountered." << nextline <<
+      "This is similar to -e except it takes a list of" << nextline <<
+      "arguments.") { |s|
+      term = s || '--'
+      args = []
+      until (arg = argv.shift) == term
+        raise "-E must end with #{term}" if arg.nil?
+
+        args << arg
+      end
+      commandline = args.map { |arg|
+        case arg
+        when /%/
+          arg.gsub(/[^A-Za-z0-9_\-.,:+\/@\n%]/, "\\\\\\&").gsub(/\n/, "'\n'")
+        else
+          arg.shellescape
+        end
+      }.join(' ')
+      filters << FileFilter.new($config.expand_alias(commandline))
+    }
+
     opts.on("-f", "--force",
       "Force editing even if a file is read-only.") {
       |b| $force = b
@@ -152,7 +181,9 @@ Edits files in-place through given filter commands.
 
   setup()
 
-  files = opts.order(*argv)
+  argv = argv.dup
+  opts.order!(argv)
+  files = argv
 
   if filters.empty? && !files.empty?
     filters << FileFilter.new($config.expand_alias(files.shift))
@@ -222,6 +253,8 @@ require 'pathname'
 
 class FileFilter
   def initialize(template)
+    raise ArgumentError, "empty command" if template.empty?
+
     @formatter = Formatter.new(template)
   end
 
@@ -466,43 +499,6 @@ class FileFilter
   end
 end
 
-if RUBY_VERSION >= "1.8.7"
-  require 'shellwords'
-else
-  class String
-    def shellescape
-      # An empty argument will be skipped, so return empty quotes.
-      return "''" if empty?
-
-      str = dup
-
-      # Process as a single byte sequence because not all shell
-      # implementations are multibyte aware.
-      str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/n, "\\\\\\1")
-
-      # A LF cannot be escaped with a backslash because a backslash + LF
-      # combo is regarded as line continuation and simply ignored.
-      str.gsub!(/\n/, "'\n'")
-
-      return str
-    end
-  end
-
-  class Tempfile
-    alias orig_make_tmpname make_tmpname
-
-    def make_tmpname(basename, n)
-      case basename
-      when Array
-        prefix, suffix = *basename
-        make_tmpname(prefix, n) + suffix
-      else
-        orig_make_tmpname(basename, n).tr('.', '-')
-      end
-    end
-  end
-end
-
 class Inplace::Config
   def initialize
     @alias = {}

data/man/inplace.1

@@ -1,7 +1,7 @@
 .\" $Idaemons: /home/cvs/inplace/inplace.1,v 1.8 2004/04/21 13:25:51 knu Exp $
 .\" $Id$
 .\"
-.Dd April 7, 2004
+.Dd November 22, 2012
 .Dt INPLACE 1
 .Os FreeBSD
 .Sh NAME
@@ -251,4 +251,17 @@ is specified, they will not be used.
 .Sh AUTHORS
 .An Akinori MUSHA Aq knu@iDaemons.org
 .Sh BUGS
-There may always be some bugs.  Use at your own risk.
+.Nm
+cannot always preserve timestamps in full precision depending on the
+ruby interpreter and the platform that
+.Nm
+runs on, that is, ruby 1.9 and later supports timestamps in
+nanoseconds but setting file timestamps in nanosecond precision is
+only possible if the platform supports
+.Xr utimensat 2 .
+.Pp
+So, a problem can arise if the file system supports nanoseconds, like
+ext4 and ZFS, but the platform does not have the system call to set
+timestamps in nanoseconds, like Linux < 2.6.22, glibc < 2.6 and
+.Fx ,
+that the sub-microsecond part of a timestamp cannot be preserved.

data/test/test.sh

@@ -97,12 +97,12 @@ cmp_file () {
 }
 
 cmp_time () {
-    # Since Ruby's File.stat() does not obtain nanosec for the moment,
-    # inplace(1) cannot preserve nanosec values and test(1)'s strict
-    # nanosec-wise check does not pass..
+    # Use ruby to compare timestamps ignoring a sub-microsecond
+    # difference.
+
     #test ! "$1" -nt "$2" -a ! "$2" -nt "$1"
 
-    if $ruby -e 'File.mtime(ARGV[0]) == File.mtime(ARGV[1]) or exit 1' "$1" "$2"; then
+    if $ruby -e 'exit !!ARGV.map{|f|m=File.mtime(f);m.to_a<<m.usec}.uniq!' "$1" "$2"; then
         debug "mtime($1) == mtime($2)"
         return 0
     else

metadata

@@ -1,34 +1,24 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: inplace
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 1
-  - 2
-  - 2
-  version: 1.2.2
+version: !ruby/object:Gem::Version
+  version: 1.3.0
 platform: ruby
-authors: 
+authors:
 - Akinori MUSHA
-autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-05 00:00:00 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-
-description: A command line utility that edits files in-place through given filter commands
-email: 
+description: A command line utility that edits files in-place through given filter
+  commands
+email:
 - knu@idaemons.org
-executables: 
+executables:
 - inplace
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - BSDmakefile
 - Gemfile
 - LICENSE
@@ -41,37 +31,26 @@ files:
 - man/inplace.1
 - test/test.sh
 homepage: https://github.com/knu/inplace
-licenses: []
-
-post_install_message: 
+licenses:
+- 2-clause BSDL
+metadata: {}
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.8.15
-signing_key: 
-specification_version: 3
-summary: Inplace(1) is a command line utility that edits files in-place through given filter commands.  e.g. inplace 'sort' file1 file2 file3
-test_files: 
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Inplace(1) is a command line utility that edits files in-place through given
+  filter commands.  e.g. inplace 'sort' file1 file2 file3
+test_files:
 - test/test.sh