file_editor_cli 0.6.0

data/README.txt

@@ -0,0 +1,45 @@
+File Editor Command Line Interface makes it easy to edit one or more files in place from the command line.
+
+===Using File Editor Command Line Interface
+
+From the command line, run the editfile script with one or more file names, a regular expression, a substition string, and options for ignoring case, non-global search, multiline search, and keeping a backup file. Although not always necessary, it is recommended to put your regex and substitution string in quotes.
+
+===Command Line Options
+
+<tt>-h</tt>:: Help screen.
+<tt>-r "regex"</tt>:: The regular expression.
+<tt>-s "substitution_string"</tt>:: The substitution string.
+<tt>-i</tt>:: Ignore case.
+<tt>-m</tt>:: Multiline mode.
+<tt>-l</tt>:: Non-global substition (equivalent of sub instead of gsub).
+<tt>-b</tt>:: Saves a backup of any changed file.
+
+===Examples
+
+====Edit a file, substituting "ruby" for "java"
+
+editfile -r "java" -s "ruby" test.txt
+
+====Edit two files
+
+editfile -r "java" -s "ruby" test.txt test2.txt
+
+====Keep a backup file
+
+editfile -b -r "java" -s "ruby" test.txt
+
+====Ignore case
+
+editfile -i -r "java" -s "ruby" test.txt
+
+====Do per-line non-global substition (equivalent of sub instead of gsub)
+
+editfile -l -r "java" -s "ruby" test.txt
+
+====Use multiline search (replace matches across line endings)
+
+editfile -m -r "ja.*?va" -s "ruby" test.txt
+
+====Note: File Editor Command Line Interface uses the file_editor gem as its regular expression and substitution engine, so no library files are necessary.
+
+

data/bin/editfile

@@ -0,0 +1,106 @@
+#!usr/bin/env ruby
+
+##############################################################
+# Copyright (c) 2013 Mark Buechler
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+##############################################################
+
+##############################################################
+#Run this executable to edit files in place
+##############################################################
+
+require 'file_editor'
+require 'optparse'
+
+##############################################
+## Method Definitions
+##############################################
+
+#Parses command line options
+def prepare_options()
+	options = {}
+	options[:global] = true #file editor default
+	OptionParser.new do |opts| 
+		opts.banner = "usage: editfile [options] [file_paths]"
+		opts.on("-h", "--help", "Display help screen") do
+			puts opts
+			exit
+		end
+		opts.on("-r", "--regex REGEX", "The regex to use") do |r|
+			options[:regex] = r
+		end
+		opts.on("-s", "--subtitution_string SUBSTITUTION_STRING", "The substitution string") do |s|
+			options[:substitution_string] = s
+		end
+		opts.on("-b", "--backup", "Keep backup file") do
+			options[:keep_backup] = true
+		end
+		opts.on("-i", "--ignore_case", "Ignore case") do
+			options[:ignore_case] = true
+		end
+		opts.on("-m", "--multiline", "Multiline") do
+			options[:multiline] = true
+		end
+		opts.on("-l", "--non_global", "First match in a line only") do
+			options[:global] = false
+		end
+	end.parse!
+	options
+end
+
+#Validates options and file-name arguments
+def validate(options, file_names)
+	if ( (options[:regex].nil?) || (options[:regex].start_with?('-')) )
+		puts "Provide a regex using the -r option"
+		exit 1
+	end
+	if ( (options[:substitution_string].nil?) || (options[:substitution_string].start_with?('-')) )
+		puts "Provide a substition string using the -s option"
+		exit 1
+	end
+	raise "Provide the name of at least one file to edit" unless file_names.size > 0 #file_editor gem will handle basic file validations (exists, is-file, etc)
+end
+
+def build_regex(options)
+	if (options[:multiline] && options[:ignore_case])
+		regex = Regexp.new(options[:regex], (Regexp::MULTILINE | Regexp::IGNORECASE))
+	elsif (options[:multiline])
+		regex = Regexp.new(options[:regex], Regexp::MULTILINE)
+	elsif (options[:ignore_case])
+		regex = Regexp.new(options[:regex], Regexp::IGNORECASE)
+	else
+		regex = Regexp.new(options[:regex])
+	end
+end
+
+def edit(options, regex, file_names)
+	file_names.each do |file_name|
+		FileEditor.edit(file_name) do |editor|
+			editor.regex = regex
+			editor.substitution_string = options[:substitution_string]
+			editor.keep_backup = options[:keep_backup]
+			editor.global = options[:global]
+			editor.run
+		end
+	end
+end
+
+##############################################
+## Program
+##############################################
+
+begin
+	files = ARGV
+	options = prepare_options
+	validate(options, files)
+	reg = build_regex(options)
+	edit(options, reg, files)
+rescue => e
+	puts "#{e.message}"
+	exit 1
+end
+

data/file_editor_cli.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+	s.name="file_editor_cli"
+	s.version="0.6.0"
+	s.platform=Gem::Platform::RUBY
+	s.date="2013-02-25"
+	s.summary="Command line utility to edit one or more files in place"
+	s.description="File editor command line makes it easy to edit files in place, with options for saving a backup"
+	s.author="Mark Buechler"
+	s.files=Dir["file_editor_cli.gemspec", "README.txt", "lib/**/*"]
+	s.homepage="http://rubygems.org/file_editor_cli"
+	s.executables=["editfile"]
+	s.require_paths=["lib"]
+	s.add_runtime_dependency "file_editor"
+	s.has_rdoc=true
+	s.extra_rdoc_files=["README.txt"]
+	s.rdoc_options=["--main", "README.txt"]
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: file_editor_cli
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Buechler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: file_editor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: File editor command line makes it easy to edit files in place, with options
+  for saving a backup
+email: 
+executables:
+- editfile
+extensions: []
+extra_rdoc_files:
+- README.txt
+files:
+- file_editor_cli.gemspec
+- README.txt
+- bin/editfile
+homepage: http://rubygems.org/file_editor_cli
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Command line utility to edit one or more files in place
+test_files: []