txt_file_mutator 0.2.2 → 0.2.4

data/.gitignore

@@ -1,5 +1,3 @@
 .DS_Store
-log/*.log
-tmp/**/*
-config/database.yml
-db/*.sqlite3
+pkg/*.gem
+*.gemspec

data/CHANGELOG

@@ -1,8 +1,17 @@
-13-11-2009: Initial release
+TODO:
+Enhance with a convenient DSL using closures (yield)
+
+with_files 'file.txt', 'file2.txt' do |files|
+  files.remove_lines 'abc', 'def'
+  files.comment_lines 'xyz', 'gfe'
+  ...
+end
+
+Test it!
 
+29-01-2010: Improved Documentation
+29-09-2009: Initial release
 Using http://rubular.com/ for testing the regexps! Let me know of any corner cases or bugs you find! :)
 
-TODO:
-* test insert_after and before only executed if not existing before! avoid content inserted multiple times before or after!
-* also have option for multiple or only once! 
+
 

data/README

@@ -1,17 +1,97 @@
 txt_file_mutator
 ================
 Kristian Mandrup, kmandrup@gmail.com
----
 
 Contains utility functions for doing simple file mutations/transformations such as:
 
-* Inserting content BEFORE a line with some specific content
-* Inserting content AFTER a line with some specific content
+* Inserting content BEFORE a line with some specific content (before-marker)
+  Has option (default=true) to only insert if no pre-existing same content before the before-marker (to disallow multiple executions to have stacking effects!)
+  - insert_before [path]
+
+  TextFileMutator.insert_after [path], [find-txt], [insert txt]
+
+  TextFileMutator.comment_line 'my/path/file.txt', '# before this', 'insert this!'
+
+* Inserting content AFTER a line with some specific content (functions same as insert_before)
+  - insert_after
+
+  TextFileMutator.insert_after [path], [find-txt], [insert txt]
+
+  TextFileMutator.comment_line 'my/path/file.txt', '# after this', 'insert this!'
+
 
 * Commenting a line with some specific content
-* Commenting a config.gem statement for a specific gem
+  - comment_line
+
+  TextFileMutator.comment_line [path], [txt]
+
+  TextFileMutator.comment_line 'my/path/file.txt', 'comment this'
+
+* Comment a config.gem statement for a specific gem
+  - comment_config_gem
+
+  TextFileMutator.comment_config_gem [path], [txt]
+
+  TextFileMutator.comment_config_gem 'my/path/file.txt', 'my-gem'
+
+* Comment a gem 'my-gem' statement 
+  - comment_rails_3_config_gem
+
 
 * Remove a line
+  - remove_line
+  
+  TextFileMutator.remove_line [file_path], [txt]  
+  
+  TextFileMutator.remove_line 'my/path/file.txt', '# remove this line'  
+  
 * Remove a require statement
+  - remove_require
+
+  TextFileMutator.remove_require [file_path], [require string]
+  
+  TextFileMutator.remove_require 'my/path/file.txt', 'rails/generators'
+
+* Replace line
+  TextFileMutator.replace_line [file_path], [old-string] [replace-string]
+  
+  Replaces each old-string found with replace-string
+
+* Remove duplicate lines
+  TextFileMutator.remove_duplicate_lines [file_path]
+
+  TextFileMutator.remove_duplicate_lines 'my/path/file.txt'
+
+* Append line
+  TextFileMutator.append_line [file_path], [content]
+  
+  TextFileMutator.append_line '/my/path/file.txt', "this line..."
+
+Investigation functions
+* has_content?
+  TextFileMutator.has_content? file_content, content
+
+  # returns true if 'blip' occurs at least once in the string
+  TextFileMutator.has_content? file('my_file.txt).read, 'blip'
+
+* has_content_before?
+
+  TextFileMutator.has_content_before? file_content, content, before
+
+  # returns true if 'blip' occurs at least once before '# before
+  TextFileMutator.has_multiple_content_before? file('my_file.txt).read, 'blip', '# before me'  me'
+
+* has_multiple_content_before?
+
+  TextFileMutator.has_multiple_content_before? file_content, content, before
+
+  # returns true if 'blip' occurs at least 2 times before the string '# before'
+  TextFileMutator.has_multiple_content_before? file('my_file.txt).read, 'blip', '# before me'  me'
+
+* has_content_after?
+  'Reverse' of has_content_before?
+
+* has_multiple_content_after?
+  'Reverse' of has_multiple_content_before?
 
 (more to come in later versions...!)

data/TODO

@@ -0,0 +1,7 @@
+Enhance with a convenient DSL using closures (yield)
+
+with_files 'file.txt', 'file2.txt' do |files|
+  files.remove_lines 'abc', 'def'
+  files.comment_lines 'xyz', 'gfe'
+  ...
+end

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.4

data/lib/txt_file_mutator.rb

@@ -1,5 +1,7 @@
+require 'rake'
+
 module TextFileMutator
-  
+    
   def self.has_multiple_content_before?(file_content, content, before) 
     res = file_content =~ /(#{content}\s*#{content})\s*#{before}/
     !res.nil?
@@ -10,6 +12,10 @@ module TextFileMutator
     !res.nil?
   end
 
+  def self.has_content?(file_content, content)
+    res = file_content =~ /#{content}/
+    !res.nil?
+  end
 
   def self.has_multiple_content_after?(file_content, content, after)
     res = file_content =~ /#{after}\s*(#{content}\s*#{content})/
@@ -21,7 +27,6 @@ module TextFileMutator
     !res.nil?
   end
   
-  
   def self.insert_before(file, line, txt_before, exist_check=true)
     content = File.read(file)
     if exist_check    
@@ -48,15 +53,21 @@ module TextFileMutator
     File.open(path, 'wb') { |file| file.write(content) }
   end
 
-
   def self.comment_gem_config(file, line)  
-    gsub_file file, /^\s*[^#]\s*config.gem.+'#{Regexp.escape(line)}'$/ do |match|
-      "# " + "#{match}"
-    end
+    comment_line_w_contents(file, 'config.gem', line)
+  end
+
+  def self.comment_rails3_gem_config(file, line)  
+    comment_line_w_contents(file, 'gem', line)
   end
 
   def self.remove_require(file, line)
-    gsub_file file, /^\s*require\s+'#{Regexp.escape(line)}'$/ do |match|
+    remove_line_w_contents file, 'require', line
+  end
+
+  # TODO: support both '' and ""
+  def self.remove_line_w_contents(file, part1, part2)
+    gsub_file file, /^\s*#{Regexp.escape(part1)}\s+'#{Regexp.escape(part2)}'$/ do |match|
       ""
     end
   end
@@ -67,6 +78,12 @@ module TextFileMutator
     end
   end
 
+  def self.comment_line_w_contents(file, part1, part2)  
+    gsub_file file, /^\s*[^#]\s*#{Regexp.escape(part1)}.+(#{Regexp.escape(part2)}$)/i do |match|
+      "# " + "#{match}"
+    end
+  end
+
   def self.remove_content(file, line)  
     gsub_file file, /(#{Regexp.escape(line)})/i do |match|
       ""
@@ -74,21 +91,150 @@ module TextFileMutator
   end
 
   def self.remove_line(file, line)  
-    gsub_file file, /^.*#{Regexp.escape(line)}.*$)/i do |match|
-      ""
+    replace_line file, line, ""
+  end
+
+  def self.replace_line(file, line, replacement)  
+    gsub_file file, /^.*#{Regexp.escape(line)}.*$/i do |match|
+      "#{replacement}"
     end
   end
 
+  def self.append_line(path, content)
+    File.open(path, 'a') do |f|
+      f.puts(content)
+    end
+  end
 
 protected
-def self.gsub_content_file(content, path, regexp, *args, &block)
-  content.gsub!(regexp, *args, &block)
-  File.open(path, 'wb') { |file| file.write(content) }
-end
+
+  def self.gsub_content_file(content, path, regexp, *args, &block)
+    content.gsub!(regexp, *args, &block)
+    File.open(path, 'wb') { |file| file.write(content) }
+  end
 
   def self.gsub_file(path, regexp, *args, &block)
     content = File.read(path).gsub(regexp, *args, &block)
     File.open(path, 'wb') { |file| file.write(content) }
   end
 
-end
+end
+
+module Rake
+  class FileList
+    def has_multiple_content_before?(content, before) 
+      each do |file|
+        t = TextFileMutator.has_multiple_content_before?(file.read, content, before)
+        return t if t
+      end    
+      false
+    end
+
+    def has_content_before?(content, before) 
+      each do |file|
+        t = TextFileMutator.has_multiple_content_after?(file.read, content, before)
+        return t if t
+      end    
+      false
+    end
+
+    def has_any_content?(content)
+      each do |file|
+        t = TextFileMutator.has_multiple_content_after?(file.read, content)
+        return t if t
+      end    
+      false
+    end
+
+    def have_all_content?(content)
+      each do |file|
+        t = TextFileMutator.has_multiple_content_after?(file.read, content)
+        return false if !t
+      end    
+      true
+    end
+
+    def has_any_multiple_content_after?(content, after)
+      each do |file|
+        t = TextFileMutator.has_multiple_content_after?(file.read, content, after)
+        return t if t
+      end    
+      false
+    end
+
+    def has_any_content_after?(content, after)
+      each do |file|
+        t = TextFileMutator.has_any_content_after?(file.read, content, after)
+        return t if t
+      end    
+      false
+    end
+  
+    def insert_before(file, line, txt_before, exist_check=true)
+      each do |file|
+        TextFileMutator.insert_before line, txt_before, exist_check
+      end    
+    end
+
+    def insert_after(file, line, txt_after, exist_check=true) 
+      each do |file|
+        TextFileMutator.insert_after line, txt_after, exist_check
+      end    
+    end
+
+    def remove_duplicate_lines(file)
+      each do |file|
+        TextFileMutator.remove_duplicate_lines
+      end    
+    end
+
+    def remove_require(file, line)
+      each do |file|
+        TextFileMutator.remove_require file, line
+      end    
+    end
+
+    # TODO: support both '' and ""
+    def remove_line_w_contents(file, part1, part2)
+      each do |file|
+        TextFileMutator.remove_line_w_contents file, part1, part2
+      end    
+    end
+
+    def comment_line(file, line)  
+      each do |file|
+        TextFileMutator.comment_line file, line
+      end    
+    end
+
+    def comment_line_w_contents(file, part1, part2)  
+      each do |file|
+        TextFileMutator.comment_line_w_contents file, part1, part2
+      end    
+    end
+
+    def remove_content(line)  
+      each do |file|
+        TextFileMutator.remove_content file, line
+      end    
+    end
+
+    def remove_line(line)  
+      each do |file|
+        TextFileMutator.remove_line file, line
+      end    
+    end
+
+    def replace_line(line, replacement)  
+      each do |file|
+        TextFileMutator.replace_line file, line, replacement
+      end    
+    end
+
+    def append_line(content)
+      each do |file|
+        TextFileMutator.append_line file, content
+      end
+    end  
+  end
+end

data/test/test_insert_before_and_after.rb

@@ -13,18 +13,32 @@ class TestTxtFileMutator < Test::Unit::TestCase
     ## Nothing really
   end
 
-  def has_content?(file, content)
-    content = File.read(file)
-    res = content =~ /#{content}/
-    !res.nil?
-  end
-
   def test_insert_before
     content = 'BEFORE'
     @tfm.insert_before @file, 'before', content
     @tfm.insert_before @file, 'before', content
 
-    assert_equal false, @tfm.has_multiple_content_before?(File.read(@file), content, 'before'), "Same content inserted should not be repeated after multiple insert before"            
+    assert_equal false, @tfm.has_multiple_content_before?(File.read(@file), content, 'before'), "Same content inserted should not be repeated after multiple insert_before"            
+  end
+
+  def test_insert_after
+    content = 'BEFORE'
+    @tfm.insert_after @file, 'after', content
+    @tfm.insert_after @file, 'after', content
+
+    assert_equal false, @tfm.has_multiple_content_after?(File.read(@file), content, 'after'), "Same content inserted should not be repeated after multiple insert_after"            
   end
 
+
+  def test_replace_line
+    content = 'replace me'
+    replace = 'with this replacement'
+    @tfm.replace_line @file, content, replace
+    
+    new_content = File.read(@file)
+    assert_equal false, @tfm.has_content?(new_content, content), "File should not contain original content"            
+    assert_equal true, @tfm.has_content?(new_content, replace), "File should contain replacement"            
+  end
+
+
 end

data/test/test_on_filelist.rb

@@ -0,0 +1,25 @@
+require 'txt_file_mutator'
+require "test/unit"
+require "rake"
+
+class TestTxtFileMutator < Test::Unit::TestCase
+
+  def setup
+    @tfm = TextFileMutator
+    @file = 'DATA.txt'
+    puts @tfm.instance_methods
+  end
+
+  def teardown
+    ## Nothing really
+  end
+
+  # include method
+  def test_comment_line
+    FileList.new('DATA_REMOVE.txt') do |files|
+      files.remove_line 'remove'
+    end
+  end
+end
+
+

data/txt_file_mutator.gemspec

@@ -5,17 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{txt_file_mutator}
-  s.version = "0.2.2"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2009-11-14}
+  s.date = %q{2010-01-30}
   s.description = %q{includes convenience method to do txt file mutations including simple code refactorings such as commenting a line}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
      "README",
-     "README.rdoc"
+     "README.rdoc",
+     "TODO"
   ]
   s.files = [
     ".document",
@@ -25,11 +26,9 @@ Gem::Specification.new do |s|
      "README",
      "README.rdoc",
      "Rakefile",
+     "TODO",
      "VERSION",
      "lib/txt_file_mutator.rb",
-     "pkg/txt_file_mutator-0.1.0.gem",
-     "pkg/txt_file_mutator-0.2.0.gem",
-     "pkg/txt_file_mutator-0.2.1.gem",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/txt_file_mutator_spec.rb",
@@ -44,6 +43,7 @@ Gem::Specification.new do |s|
     "spec/spec_helper.rb",
      "spec/txt_file_mutator_spec.rb",
      "test/test_insert_before_and_after.rb",
+     "test/test_on_filelist.rb",
      "test/test_remove_line_w_content.rb",
      "test/test_txt_file_mutator.rb"
   ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: txt_file_mutator
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-14 00:00:00 +01:00
+date: 2010-01-30 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,7 @@ extra_rdoc_files:
 - LICENSE
 - README
 - README.rdoc
+- TODO
 files: 
 - .document
 - .gitignore
@@ -40,11 +41,9 @@ files:
 - README
 - README.rdoc
 - Rakefile
+- TODO
 - VERSION
 - lib/txt_file_mutator.rb
-- pkg/txt_file_mutator-0.1.0.gem
-- pkg/txt_file_mutator-0.2.0.gem
-- pkg/txt_file_mutator-0.2.1.gem
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/txt_file_mutator_spec.rb
@@ -81,5 +80,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/txt_file_mutator_spec.rb
 - test/test_insert_before_and_after.rb
+- test/test_on_filelist.rb
 - test/test_remove_line_w_content.rb
 - test/test_txt_file_mutator.rb