file_mutate 0.1.2

data/lib/file_mutate/replace_content.rb

@@ -0,0 +1,44 @@
+module FileMutate
+  module ReplaceContent
+    def replace_content options = {}, &block
+      File.replace_content_from self.path, options, &block
+    end
+
+    module ClassMethods
+      # replaces content found at replacement_expr with content resulting from yielding block
+      # File.replace_content_from 'myfile.txt', where => /HelloWorld/, with => 'GoodBye'
+      def replace_content_from file_name, options = {}, &block
+        replacement_expr = options[:where] || options[:content]
+        new_content = options[:with]
+
+        begin
+          replacement_expr = replacement_expr.to_regexp
+        rescue
+          raise ArgumentError, "Content to be replaced must be specified as either a String or Regexp in a :where or :content option"
+        end
+
+        file = get_file file_name
+
+        # get existing file content
+        content = file.read
+
+        # return nil if no mathing replacement found
+        return nil if !(content =~ replacement_expr)
+
+        new_content ||= yield if block
+
+        raise ArgumentError, "Content to be replaced with must be specified as a :with option or as a block" if !new_content
+
+        # remove content that matches expr, by replacing with empty
+        mutated_content = content.gsub replacement_expr, new_content
+
+        # write mutated content as new file
+        file.overwrite mutated_content
+
+        true # signal success!
+      end
+      alias_method :replace_content_in, :replace_content_from
+    end
+  end
+end
+

data/lib/file_mutation.rb

@@ -0,0 +1,46 @@
+require 'sugar-high/blank'
+require 'sugar-high/arguments'
+require 'sugar-high/path'
+require 'sugar-high/regexp'
+require 'sugar-high/string'
+require 'sugar-high/file'
+require 'sugar-high/array'
+require 'sweetloader'
+
+require 'active_support/inflector'
+
+class Module
+  def file_mutate name
+    if name == :all
+      FileMutate.add_all self
+      return
+    end
+    FileMutate.add_mutate_exts self, [:mutate, name]
+  end
+end
+
+module FileMutate
+  autoload_modules :Mutate, :Delete, :AppendContent, :InsertContent
+  autoload_modules :OverwriteContent, :RemoveContent, :ReplaceContent
+
+  def self.mutate_apis
+    [:delete, :mutate, :append_content, :insert_content, :overwrite_content, :remove_content, :replace_content]
+  end
+
+  def self.add_all clazz
+    add_mutate_exts clazz, mutate_apis
+  end
+
+  def self.add_mutate_exts clazz, *names
+    names.flat_uniq!
+    unknowns = (names - mutate_apis)
+    raise ArgumentError, "Unknown FileMutate APIs: #{unknowns}, must be one of: #{mutate_apis}" if !unknowns.empty?
+    names.each do |api|
+      ns = "FileMutate::#{api.to_s.camelize}"
+      begin
+        clazz.send :include, ns.constantize
+        clazz.extend "#{ns}::ClassMethods".constantize
+      end
+    end
+  end
+end

data/spec/file_mutate/append_content_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+File.file_mutate :append_content
+
+describe FileMutate do
+  let(:empty_file)      { fixture_file 'empty.txt' }
+  let(:replace_file)    { fixture_file 'file.txt' }
+
+  describe '#append with :content option' do
+    let(:append_file)    { fixture_file 'file.txt' }
+
+    it 'should append content to existing file - class method' do
+      File.overwrite(append_file) do
+        'Hello You'
+      end
+      File.append append_file, :content => 'Appended'
+      content = File.read(append_file)
+      content.should match /Hello You/
+      content.should match /Appended/
+    end
+
+    it 'should append content to existing file - instance method' do
+      File.overwrite(append_file) do
+        'Hello You'
+      end
+      File.new(append_file).append :content => 'Appended'
+      content = File.read(append_file)
+      content.should match /Hello You/
+      content.should match /Appended/
+    end
+  end
+
+  describe '#append with block' do
+    let(:append_file)    { fixture_file 'file.txt' }
+
+    it "should append content to existing file using block arg - class method" do
+      File.overwrite(append_file) do
+        'Hello You'
+      end
+      File.append append_file do
+        'Appended'
+      end
+      content = File.read(replace_file)
+      content.should match /Hello You/
+      content.should match /Appended/
+    end
+
+    it "should append content to existing file using block arg - instance method" do
+      File.overwrite(append_file) do
+        'Hello You'
+      end
+      File.new(append_file).append do
+        'Appended'
+      end
+      content = File.read(replace_file)
+      content.should match /Hello You/
+      content.should match /Appended/
+    end
+  end
+end

data/spec/file_mutate/delete_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+File.file_mutate :delete
+
+describe FileMutate do
+  let(:file_to_delete)  { fixture_file 'file_to_delete.txt' }
+
+  describe '#delete! (class)' do
+    it 'should delete file' do
+      File.overwrite(file_to_delete) do
+        'Delete this!'
+      end
+      File.delete! file_to_delete
+      File.exist?(file_to_delete).should be_false
+    end
+  end
+
+  describe '#delete_file! (class)' do
+    it 'should delete file' do
+      File.overwrite(file_to_delete) do
+        'Delete this!'
+      end
+      File.delete_file! file_to_delete
+      File.exist?(file_to_delete).should be_false
+    end
+  end
+
+  describe '#delete! (instance)' do
+    it 'should delete file' do
+      File.overwrite(file_to_delete) do
+        'Delete this!'
+      end
+      File.new(file_to_delete).delete!
+      File.exist?(file_to_delete).should be_false 
+    end
+  end
+
+  describe '#delete_file! (instance)' do
+    it 'should delete file' do
+      File.overwrite(file_to_delete) do
+        'Delete this!'
+      end
+      File.new(file_to_delete).delete_file!
+      File.exist?(file_to_delete).should be_false 
+    end
+  end
+end

data/spec/file_mutate/insert_before_last_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+File.file_mutate :insert_content
+
+describe FileMutate do
+  let(:empty_file)      { fixture_file 'empty.txt' }
+  let(:class_file)      { fixture_file 'class_file.rb'}
+  let(:routes_file)     { fixture_file 'routes_file.rb' }
+  let(:app_file)        { fixture_file 'application_file.rb' }
+
+  describe '#insert_into' do
+    let(:insertion_file)    { fixture_file 'insertion.txt' }
+    before :each do
+      File.overwrite(insertion_file) do
+        'Goodbye'
+      end
+    end
+
+    after :each do
+      File.delete insertion_file if File.file?(insertion_file)
+    end
+
+
+    describe '#insert before last' do
+      context ':content option and :before_last option' do
+        it "should insert Hello before last end statement" do
+          File.insert_into class_file, :content => '  # Hello', :before_last => 'end' 
+          puts File.read(class_file)
+          File.read(class_file).should match /end\s+# Hello\s+end/
+          File.remove_content_from class_file, :content => '  # Hello'
+        end
+      end
+
+      context ':content option and :before_last option and repeat=true' do
+        it "should insert Hello before last end statement but don't repeat" do
+          File.insert_into class_file, :content => '  # Hello', :before_last => 'end', :no_repeat => true
+          puts File.read(class_file)
+          File.read(class_file).should match /end\s+# Hello\s+end/
+          File.remove_content_from class_file, :content => '  # Hello'
+        end
+      end
+
+      context 'block content and :before_last' do
+        it "should insert Hello before last end statement" do
+          File.insert_into class_file, :before_last => 'end' do
+            '  # Hello'
+          end
+          puts File.read(class_file)
+          File.read(class_file).should match /end\s+# Hello\s+end/
+          File.remove_content_from class_file, :content => '  # Hello'
+        end
+      end
+    end
+  end
+end

data/spec/file_mutate/insert_content_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+File.file_mutate :insert_content
+
+describe FileMutate do
+  let(:empty_file)      { fixture_file 'empty.txt' }
+  let(:class_file)      { fixture_file 'class_file.rb'}
+  let(:routes_file)     { fixture_file 'routes_file.rb' }
+  let(:app_file)        { fixture_file 'application_file.rb' }
+
+  describe '#insert_into' do
+    let(:insertion_file)    { fixture_file 'insertion.txt' }
+
+    before :each do
+      File.overwrite(insertion_file) do
+        'Goodbye'
+      end
+    end
+
+    after :each do
+      File.delete insertion_file if File.file?(insertion_file)
+    end
+
+    context 'File object as target' do
+      it "should insert Hello before Goodbye" do
+        ins_file = File.new(insertion_file)
+        ins_file.read_content.should match /Goodbye/
+
+        ins_file.has_content?('Goodbye').should be_true
+
+        File.insert_into ins_file, :before => 'Goodbye' do
+          'Hello'
+        end
+        ins_file.read_content.should match /Hello\s+Goodbye/
+      end
+
+      context 'content as block argument' do
+        it "should insert Hello before Goodbye" do
+          File.insert_into insertion_file, :before => 'Goodbye' do
+            'Hello'
+          end
+          File.read(insertion_file).should match /Hello\s+Goodbye/
+        end
+      end
+    end
+
+    describe '#insert instance method' do
+      context 'content as block argument' do
+        it "should insert Hello before Goodbye" do
+          File.new(insertion_file).insert :before => 'Goodbye' do
+            'Hello'
+          end
+          File.read(insertion_file).should match /Hello\s+Goodbye/
+        end
+      end
+
+      context 'content as String argument' do
+        it "should insert Hello before Goodbye using a content string arg" do
+          File.insert_into insertion_file, "Hello ", :before => 'Goodbye'
+          File.read(insertion_file).should match /Hello\s+Goodbye/
+        end
+      end
+
+      context 'using a :content option' do
+        it "should insert Hello before Goodbye" do
+          File.insert_into insertion_file, :content => 'Hello', :before => 'Goodbye'
+          File.read(insertion_file).should match /Hello\s+Goodbye/
+        end
+      end
+
+      describe 'insert after' do
+        context 'Regexp for the :after expression' do
+          it "should insert Hello after Goodbye using a :content option" do
+            File.insert_into insertion_file, :content => ' Hello', :after => /Goodbye/
+            File.read(insertion_file).should match /Goodbye\s+Hello/
+          end
+
+          it "should work with an escaped Regexp matching" do
+            pattern = Regexp.escape('::Application.initialize!')
+            File.insert_into app_file, :after => /\w+#{pattern}/ do
+              'hello'
+            end
+            File.read(app_file).should match /hello/
+          end
+        end
+      end
+    end
+
+    context 'routes file - String path' do
+      it "should insert devise routes statement as first route statement" do
+        File.insert_into routes_file, :after => 'routes.draw do' do
+          'devise :users'
+        end
+        # puts File.read(routes_file)
+        File.read(routes_file).should match /routes.draw\s+do\s+devise :users/
+        File.remove_content_from routes_file, :content => 'devise :users'
+      end
+    end
+
+    context 'routes file - File obj' do
+      it "should insert devise routes statement as first route statement" do
+        File.insert_into File.new(routes_file), :after => 'routes.draw do' do
+          'devise :users'
+        end
+        # puts File.read(routes_file)
+        File.read(routes_file).should match /routes.draw\s+do\s+devise :users/
+        File.remove_content_from routes_file, :content => 'devise :users'
+      end
+    end
+  end
+end

data/spec/file_mutate/overwrite_content_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+File.file_mutate :overwrite_content
+
+describe FileMutate do
+  let(:empty_file)      { fixture_file 'empty.txt' }
+  let(:non_empty_file)  { fixture_file 'non-empty.txt' }
+  let(:content_file)    { fixture_file 'content_file.txt' }
+
+  before :each do
+    File.overwrite(content_file) do
+      'Goodbye'
+    end
+  end
+
+  describe 'File #overwrite class method' do
+    describe '#overwrite with block arg' do
+      context 'empty file' do 
+        let (:content) { 'Overwritten!!!' }
+
+        it 'should overwrite empty file' do
+          File.overwrite content_file do
+            content
+          end
+          cf = File.new(content_file)
+          cf.has_content?(content).should be_true
+          cf.delete!
+        end
+      end
+
+      context 'non-empty file' do
+        let (:content) { 'Overwritten!!!' }
+
+        it 'should overwrite file content with new content, erasing the old' do
+          File.overwrite content_file do
+            content
+          end
+
+          new_content = "New content"
+          File.overwrite content_file do
+            new_content
+          end
+
+          cf = File.new(content_file)
+          cf.has_content?(content).should be_false
+          cf.has_content?(new_content).should be_true
+        end
+      end
+    end
+
+    describe '#overwrite! (instance)' do
+      let (:content) { 'Overwritten!!!' }
+
+      describe '#overwrite with block argument' do
+        it 'should overwrite empty file' do
+          cf = File.new(content_file)
+          cf.overwrite do
+            content
+          end
+          cf.has_content?(content).should be_true
+          File.delete! content_file
+        end
+      end
+
+      describe '#overwrite using :with option arg' do
+        it 'should overwrite file content with new content, erasing the old' do
+          cf = File.new(content_file)
+          cf.overwrite :with => content
+
+          new_content = "New content"
+          cf.overwrite :with => new_content
+
+          cf.has_content?(content).should be_false
+          cf.has_content?(new_content).should be_true
+        end
+      end
+    end
+  end
+end

data/spec/file_mutate/remove_content_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+File.file_mutate :remove_content
+
+describe FileMutate do
+  let(:empty_file)      { fixture_file 'empty.txt' }
+  let(:non_empty_file)  { fixture_file 'non-empty.txt'}
+  let(:class_file)      { fixture_file 'class_file.rb'}
+  let(:replace_file)    { fixture_file 'file.txt' }
+  let(:file_to_delete)  { fixture_file 'file_to_delete.txt' }
+  let(:routes_file)     { fixture_file 'routes_file.rb' }
+  let(:app_file)        { fixture_file 'application_file.rb' }
+
+  describe '#remove_content_from with :where option' do
+    let(:replace_file)    { fixture_file 'file.txt' }
+
+    it "should remove content from existing file - class method" do
+      File.overwrite(replace_file) do
+        'Hello You'
+      end
+      File.remove_content_from replace_file, :where => 'You'
+      File.read(replace_file).should_not match /You/
+    end
+
+    it "should remove content from existing file - instance method #remove_content" do
+      File.overwrite(replace_file) do
+        'Hello You'
+      end
+      File.new(replace_file).remove_content :where => 'You'
+      File.read(replace_file).should_not match /You/
+    end
+
+  end
+
+  describe '#remove_content_from with :content option' do
+    let(:replace_file)    { fixture_file 'file.txt' }
+
+    it "should remove content from existing file - class method" do
+      File.overwrite(replace_file) do
+        'Hello You'
+      end
+      File.remove_content_from replace_file, :content => 'You'
+      File.read(replace_file).should_not match /You/
+    end
+
+    it "should remove content from existing file - instance method #remove_content" do
+      File.overwrite(replace_file) do
+        'Hello You'
+      end
+      File.new(replace_file).remove_content 'You'
+      File.read(replace_file).should_not match /You/
+    end
+  end
+
+  describe '#remove_from with String/Regexp argument that is content to remove' do
+    let(:replace_file)    { fixture_file 'file.txt' }
+
+    it "should remove content from existing file - class method" do
+      File.overwrite(replace_file) do
+        'Hello You'
+      end
+      File.remove_from replace_file, 'You'
+      File.read(replace_file).should_not match /You/
+    end
+
+    it "should remove content from existing file - instance method #remove" do
+      File.overwrite(replace_file) do
+        'Hello You'
+      end
+      File.new(replace_file).remove_content 'You'
+      File.read(replace_file).should_not match /You/
+    end
+  end
+
+  describe '#remove_from with block argument that is content to remove' do
+    let(:replace_file)    { fixture_file 'file.txt' }
+
+    it "should work using File object as target" do
+      fr = File.new replace_file
+      File.overwrite(fr) do
+        'Hello You'
+      end
+      File.remove_from fr do
+        'You'
+      end
+      File.read(fr).should_not match /You/
+    end
+
+    it "should remove content from existing file - class method" do
+      File.overwrite(replace_file) do
+        'Hello You'
+      end
+      File.remove_from replace_file do
+        'You'
+      end
+      File.read(replace_file).should_not match /You/
+    end
+
+    it "should remove content from existing file - instance method #remove" do
+      File.overwrite(replace_file) do
+        'Hello You'
+      end
+      File.new(replace_file).remove  do
+        'You'
+      end
+      File.read(replace_file).should_not match /You/
+    end
+  end
+end