file_mutate 0.1.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color --format nested

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem "activesupport", ">= 3.0.1"
+gem "i18n"
+gem "sugar-high",    ">= 0.6.0"
+gem "sweetloader",   ">= 0.1.0"
+
+
+group :development do
+  gem "shoulda",  ">= 0"
+  gem "rspec",    ">= 2.4.1"
+  gem "bundler",  ">= 1.0.11"
+  gem "jeweler",  ">= 1.6.4"
+  gem "rcov",     ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kristian Mandrup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,49 @@
+h1. File Mutate
+
+A File Muatation DSL and API that is easy to add to any module or class.
+It is often convenient to extend the core File class with the file mutation APIs in order to gain a better DSL
+for performing file mutations.
+
+This gem has been extracted from the "sugar-high":https://github.com/kristianmandrup/sugar-high gem
+
+h2. Content Mutation DSL
+
+File mutation modules:
+
+* Append content
+* Insert content
+* Overwrite content
+* Remove content
+* Replace content
+
+* Delete files
+
+The modules follow the naming convention: @FileMutate::AppendContent@
+
+h2. Usage
+
+To include all file mutation modules:
+
+@File.file_mutate :all@
+
+To include set of file mutation modules:
+
+@File.file_mutate :append, :insert@
+
+Note that the @file_mutate@ macro is made available for all modules.
+
+h2. Contributing to file_mutate
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+h2. Copyright
+
+Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "file_mutate"
+  gem.homepage = "http://github.com/kristianmandrup/file_mutate"
+  gem.license = "MIT"
+  gem.summary = %Q{Adds file mutation DSL to any module or extends File class}
+  gem.description = %Q{The file mutation DSL you always wish was included in Ruby}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/file_mutate.gemspec

@@ -0,0 +1,97 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{file_mutate}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Kristian Mandrup}]
+  s.date = %q{2011-08-24}
+  s.description = %q{The file mutation DSL you always wish was included in Ruby}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.textile"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "file_mutate.gemspec",
+    "lib/file_mutate.rb",
+    "lib/file_mutate/append_content.rb",
+    "lib/file_mutate/delete.rb",
+    "lib/file_mutate/insert_content.rb",
+    "lib/file_mutate/mutate.rb",
+    "lib/file_mutate/overwrite_content.rb",
+    "lib/file_mutate/remove_content.rb",
+    "lib/file_mutate/replace_content.rb",
+    "lib/file_mutation.rb",
+    "spec/file_mutate/append_content_spec.rb",
+    "spec/file_mutate/delete_spec.rb",
+    "spec/file_mutate/insert_before_last_spec.rb",
+    "spec/file_mutate/insert_content_spec.rb",
+    "spec/file_mutate/overwrite_content_spec.rb",
+    "spec/file_mutate/remove_content_spec.rb",
+    "spec/file_mutate/replace_content_spec.rb",
+    "spec/fixtures/application_file.rb",
+    "spec/fixtures/class_file.rb",
+    "spec/fixtures/class_file.txt",
+    "spec/fixtures/content_file.txt",
+    "spec/fixtures/empty.txt",
+    "spec/fixtures/file.txt",
+    "spec/fixtures/non-empty.txt",
+    "spec/fixtures/routes_file.rb",
+    "spec/fixtures/search_file.txt",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/file_mutate}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.8}
+  s.summary = %q{Adds file mutation DSL to any module or extends File class}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.1"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<sugar-high>, [">= 0.6.0"])
+      s.add_runtime_dependency(%q<sweetloader>, [">= 0.1.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.4.1"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.11"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.1"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<sugar-high>, [">= 0.6.0"])
+      s.add_dependency(%q<sweetloader>, [">= 0.1.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.4.1"])
+      s.add_dependency(%q<bundler>, [">= 1.0.11"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.1"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<sugar-high>, [">= 0.6.0"])
+    s.add_dependency(%q<sweetloader>, [">= 0.1.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.4.1"])
+    s.add_dependency(%q<bundler>, [">= 1.0.11"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/file_mutate.rb

@@ -0,0 +1,2 @@
+require 'file_mutation'
+

data/lib/file_mutate/append_content.rb

@@ -0,0 +1,16 @@
+module FileMutate
+  module AppendContent
+    def append content=nil, &block
+      File.append self.path, content, &block
+    end
+
+    module ClassMethods
+      def append path, content=nil, &block
+        File.open(path, 'a') do |f|
+          f.puts content ||= yield
+        end
+      end
+    end
+  end
+end
+

data/lib/file_mutate/delete.rb

@@ -0,0 +1,28 @@
+require 'sugar-high/blank'
+require 'sugar-high/arguments'
+require 'sugar-high/path'
+require 'sugar-high/regexp'
+require 'sugar-high/string'
+require 'sugar-high/file'
+
+module FileMutate
+  module Delete
+    module ClassMethods
+      def delete! name
+        return nil if !File.exist?(name)
+        File.delete name
+      end
+      alias_method :delete_file!, :delete!
+    end
+
+    def delete!
+      File.delete(self.path)
+    end
+    alias_method :delete_file!, :delete!
+
+    def mutate marker, place, &block
+      File.mutate_file self.path, marker, place, &block
+    end
+  end
+end
+

data/lib/file_mutate/insert_content.rb

@@ -0,0 +1,61 @@
+module FileMutate
+  module InsertContent
+    def insert *args, &block
+      File.insert_into self.path, *args, &block
+    end
+
+    module ClassMethods
+      # insert_into 'my_file.txt', :after => 'Blip', :content => 'Hello
+      # insert_into 'my_file.txt', 'Hello', :after => 'Blip' 
+      # insert_into 'my_file.txt', :after => 'Blip' do 
+      #  'Hello'
+      # end  
+      def insert_into file_name, *args, &block
+        options = last_option args
+        content = insertion_content options, *args, &block
+
+        # no content to insert?
+        return nil if content.blank? 
+
+        file = begin
+                 get_file(file_name)
+               rescue
+                 return nil
+               end
+
+        # already inserted?
+        return nil if !options[:repeat] && file.has_content?(content)
+
+        # find where to insert
+        place, marker = if options[:before] 
+                          [ :before, options[:before] ]
+                        elsif options[:before_last]
+                          [ :before_last, options[:before_last] ]
+                        else
+                          [ :after, options[:after] ]
+                        end 
+
+        return nil if !file.has_content?(marker)
+
+        # do mutation
+        res = file.mutate marker, place do
+          content
+        end
+        res
+      end
+
+      def insertion_content options = {}, *args, &block
+        case args.first
+        when String
+          args.first
+        when Hash
+          options[:content] || (yield if block)      
+        else
+          return yield if block
+          raise ArgumentError, "You must supply content to insert, either as a String before the options hash, a :content option or a block" 
+        end     
+      end
+    end
+  end
+end
+

data/lib/file_mutate/mutate.rb

@@ -0,0 +1,56 @@
+module FileMutate
+  module Mutate
+    module ClassMethods
+      def mutate_file file, marker, place, &block
+        raise ArgumentError, "You must define a replacement marker for a :before, :before_last or :after key" if !marker 
+
+        file = File.get_file(file)
+
+        if place == :before_last
+          content = file.read
+          content = content.insert_before_last yield, marker
+          file.overwrite content
+          return
+        end
+
+        marker_found = file.has_content? marker
+        return nil if !marker_found
+
+        replace_in_file file, /(#{marker})/mi do |match|
+          place == :after ? "#{match}\n  #{yield}" : "#{yield}\n  #{match}"
+        end
+        true
+      end
+
+      def replace_in_file(file, regexp, *args, &block)
+        file = File.get_file(file)
+        content = file.read.gsub(regexp, *args, &block)
+        file.overwrite content
+      end
+
+
+      def get_file file_name
+        case file_name
+        when PathString, String 
+          File.new file_name
+        when File
+          file_name
+        else
+          raise ArgumentError, "Could not be converted to a File object: #{file_name}"
+        end
+      end
+
+      def get_filepath file
+        case file
+        when PathString, String 
+          file
+        when File
+          file.path
+        else
+          raise ArgumentError, "Could not be converted to a file path: #{file_name}"
+        end
+      end
+    end
+  end
+end
+

data/lib/file_mutate/overwrite_content.rb

@@ -0,0 +1,16 @@
+module FileMutate
+  module OverwriteContent
+    def overwrite content=nil, &block
+      File.overwrite self.path, content, &block
+    end
+
+    module ClassMethods
+      def overwrite file, content=nil, &block
+        File.open(get_filepath(file).path, 'w') do |f|
+          f.puts content ||= yield
+        end
+      end
+    end
+  end
+end
+

data/lib/file_mutate/remove_content.rb

@@ -0,0 +1,32 @@
+module FileMutate
+  module RemoveContent
+    def remove_content options=nil, &block
+      opt_str = case options
+                when String
+                  options
+                when Hash
+                  content = options[:content] || options[:where]
+                  raise ArgumentError, "Bad :content value in Hash" if !content || content.strip.empty?
+                  content.strip
+                else
+                  raise ArgumentError, "non-block argument must be either String or Hash with a :content option" if !block
+                end
+      content = block ? yield : opt_str
+
+      File.remove_content_from self.path, :content => content, :with => '', &block
+    end
+    alias_method :remove, :remove_content
+
+    module ClassMethods
+      def remove_from file_name, content=nil, &block
+        content ||= yield
+        replace_content_from file_name, :content => content, :with => '', &block
+      end
+
+      def remove_content_from file_name, options = {}, &block
+        replace_content_from file_name, options.merge(:with => ''), &block
+      end
+    end
+  end
+end
+