prependfile 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in prependfile.gemspec
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+PrependFile
+=============
+
+Due to the fact that most file systems do not support prepend operations, I decided to create a simple gem to do just that.
+
+
+##Usage
+
+### Command Line
+
+    Usage:
+       prependfile [options] target_file
+
+    Examples:
+      
+      prependfile file.cpp --text="PUT THIS ON TOP"
+
+      prependfile file.cpp main.cpp test.cpp --text="This goes on all of them!"
+
+      prependfile *.cpp --file=banner.txt
+
+      prependfile *.rb (this will put you into STDIN)
+
+      prependfile *.rb < banner.txt
+
+    where [options] are:
+      --text, -t <s>:   Text to prepend to file
+      --file, -f <s>:   Contents of file to prepend to the dest file
+       --version, -v:   Print version and exit
+      --help, -h:   Show this message
+
+
+### Ruby Code  
+
+  **General**
+
+    require 'prependfile'
+    
+    PrependFile.prepend(<file_to_append>, <text_to_prepend>)
+
+  `<file_to_append>` and `<text_to_prepend>` can be a filename(String), File Object, or IO Object
+
+
+  **Examples**
+
+    PrependFile.prepend("sample.txt", "I want this text to be on the top!")
+
+    PrependFile.prepend("sample.txt", File.new("file_that_contains_header.txt")
+
+    PrependFile.prepend(File.new("sample.txt"), "I want this text to be on the top!")
+
+   To see all examples/cases, see the spec file.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/prependfile

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+f = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+require File.join(File.dirname(f), '..', 'lib', 'prependfile')
+begin
+  require 'trollop'
+rescue LoadError
+  require 'rubygems'
+  require 'trollop'
+end
+
+opts = Trollop::options do
+  version "PrependFile (c) 2011 Mike Lewis"
+  banner <<-EOS
+prependfile prepends text to FILEs
+
+Usage:
+       prependfile [options] target_file
+
+Examples:
+      
+      prependfile file.cpp --text="PUT THIS ON TOP"
+
+      prependfile file.cpp main.cpp test.cpp --text="This goes on all of them!"
+
+      prependfile *.cpp --file=banner.txt
+
+      prependfile *.rb (this will put you into STDIN)
+
+      prependfile *.rb < banner.txt
+
+where [options] are:
+  EOS
+
+  opt :text, "Text to prepend to file", :type => String
+  opt :file, "Contents of file to prepend to the dest file", :type => String
+end
+
+Trollop::die "need to give a file to prepend to" if ARGV.empty?
+
+
+prepend_content = if opts[:text]
+   [*opts[:text]]
+elsif opts[:file]
+  Trollop::die :file, "must exist" unless File.file?(opts[:file]) && File.exist?(opts[:file])
+  File.readlines(opts[:file])
+else
+  lines = []
+  while(line=$stdin.gets)
+    lines << line
+  end
+  lines
+end.join
+
+unless prepend_content
+  Trollop::die "need to use either the --text or --file option if no text is given via STDIN"
+end
+
+ARGV.each{|f| PrependFile.prepend(f, prepend_content)}

data/lib/prependfile.rb

@@ -0,0 +1,41 @@
+require 'fileutils'
+require 'tempfile'
+
+module PrependFile
+  class << self
+    def prepend(old_file, data)
+      temp_file = Tempfile.open('prependfile')
+      begin
+        #prepend data
+        write_to_temp(temp_file, data)
+        #write old file to temp
+        write_to_temp(temp_file, old_file)
+        #move temp file to original location
+        move_temp_to_original(temp_file, old_file)
+      ensure
+        temp_file.close
+        temp_file.unlink
+      end
+    end
+
+    private
+
+    def move_temp_to_original(temp, original)
+      original = original.path unless original.is_a?(String)
+      FileUtils.mv(temp.path, original)
+    end
+
+    def write_to_temp(temp_file, data)
+      if data.is_a?(IO) || data.is_a?(File)
+        temp_file.write data.read
+      elsif data.is_a?(String)
+        if File.file?(data)
+          temp_file.write File.read(data)
+        else
+          temp_file.puts data.to_s
+        end
+      end
+    end
+  end
+
+end

data/lib/prependfile/version.rb

@@ -0,0 +1,3 @@
+module PrependFile
+  VERSION = "0.2.0"
+end

data/prependfile.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "prependfile/version"
+
+Gem::Specification.new do |s|
+  s.name        = "prependfile"
+  s.version     = PrependFile::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mike Lewis"]
+  s.email       = ["ft.mikelewis@gmail.com"]
+  s.homepage    = "http://github.com/mikelewis/prependfile"
+  s.summary     = %q{Prepend any file with text (think licenses, copyright, ownership etc)}
+  s.description = %q{Prepend any file with text (think licenses, copyright, ownership etc)}
+
+  s.rubyforge_project = "prependfile"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency('trollop')
+
+  s.add_development_dependency('rspec')
+
+end

data/spec/bin_spec.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "prependfile binary" do
+  before do
+    @sample_files_with_content = {
+      "sample_files/sample.txt" => File.read("sample_files/sample.txt"),
+      "sample_files/other_sample.txt" => File.read("sample_files/other_sample.txt")
+    }
+  end
+
+  after do
+    @sample_files_with_content.each do |path, contents| 
+      File.open(path, 'w'){|f| f.write contents}
+    end
+  end
+
+  it "should accept --text argument" do
+    file_path = "sample_files/sample.txt"
+    run_bin "#{abs_sample_file_path("sample.txt").join} --text='hi guys'"
+    File.read(file_path).should eq("hi guys\n#{@sample_files_with_content[file_path]}")
+  end
+
+  it "should accept -t argument" do
+    file_path = "sample_files/sample.txt"
+    run_bin "#{abs_sample_file_path("sample.txt").join} -t 'hi guys'"
+    File.read(file_path).should eq("hi guys\n#{@sample_files_with_content[file_path]}")
+
+  end
+
+  it "should accept --file argument" do
+    file_path = "sample_files/sample.txt"
+    run_bin "#{abs_sample_file_path("sample.txt").join} --file=#{abs_sample_file_path("prepend_data").join}"
+    File.read(file_path).should eq("#{File.read('sample_files/prepend_data')}#{@sample_files_with_content[file_path]}")
+  end
+
+  it "should accept -f argument" do
+        file_path = "sample_files/sample.txt"
+    run_bin "#{abs_sample_file_path("sample.txt").join} -f #{abs_sample_file_path("prepend_data").join}"
+    File.read(file_path).should eq("#{File.read('sample_files/prepend_data')}#{@sample_files_with_content[file_path]}")
+
+  end
+
+  it "should accept STDIN" do
+    file_path = "sample_files/sample.txt"
+    run_bin "#{abs_sample_file_path("sample.txt").join} < #{abs_sample_file_path("prepend_data").join}"
+    File.read(file_path).should eq("#{File.read('sample_files/prepend_data')}#{@sample_files_with_content[file_path]}")
+  end
+
+  it "should accept multiple files as input" do
+    run_bin "#{abs_sample_file_path("sample.txt","other_sample.txt").join(" ")} --text='hi guys'"
+    @sample_files_with_content.each do |path, content|
+      File.read(path).should eq("hi guys\n#{content}")
+    end
+  end
+
+  it "should not accept zero files" do
+    run_bin(" 2> /dev/null")
+    $?.success?.should eq(false)
+  end
+
+  it "should not accept zero files and give a stderror message" do
+    run_bin(" 2>&1").should match(/need to give a file to prepend to/)
+  end
+
+  it "should not accept a none existant --file" do
+    run_bin("--file=blahblah 2> /dev/null")
+    $?.success?.should eq(false)
+  end
+
+  it "should not accept a none existant --file and give a stderror message" do
+    run_bin("--file=blahblah 2>&1").should match(/Error: need to give a file to prepend to/)
+  end
+
+  it "should not accept a directory for --file" do
+    run_bin("--file=/dev 2> /dev/null")
+    $?.success?.should eq(false)
+  end
+  
+  it "should not accept a none existant --file and give a stderror message" do
+    run_bin("--file=/dev 2>&1").should match(/Error: need to give a file to prepend to/)
+  end
+end

data/spec/prependfile_spec.rb

@@ -0,0 +1,115 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe PrependFile do
+  context "Dest File is a location" do
+    before do
+      @file_name = "sample_files/sample.txt"
+      @original_contents = File.read(@file_name)
+    end
+
+    after do
+      File.open(@file_name, 'w') {|f| f.write @original_contents}
+    end
+
+    it "should prepend text to a file given a file name" do
+      PrependFile.prepend(@file_name, "This is text")
+      File.read(@file_name).should eq("This is text\n#{@original_contents}")
+    end
+
+    it "should prepend a file from a given file location to a file given a file name" do
+      PrependFile.prepend(@file_name, "sample_files/prepend_data" )
+      File.read(@file_name).should eq("#{File.read('sample_files/prepend_data')}#{@original_contents}")
+    end
+
+    it "should prepend a file from a given file object to a file given a file name" do
+      PrependFile.prepend(@file_name, File.new("sample_files/prepend_data"))
+      File.read(@file_name).should eq("#{File.read('sample_files/prepend_data')}#{@original_contents}")
+    end
+
+    it "should prepend a file from a given IO object to a file given a file name" do
+      PrependFile.prepend(@file_name, File.open("sample_files/prepend_data", 'r'))
+      File.read(@file_name).should eq("#{File.read('sample_files/prepend_data')}#{@original_contents}")
+    end
+  end
+
+  context "Dest File is a File Object" do
+    before do
+      @file_name = "sample_files/sample.txt"
+      @file = File.new @file_name
+      @original_contents = @file.read
+      @file.rewind
+    end
+
+    after do
+      File.open(@file_name, 'w') {|f| f.write @original_contents}
+    end
+
+    it "should reach the end of the given source file" do
+      PrependFile.prepend(@file, "This is text")
+      @file.eof?.should eq(true)
+    end
+
+    it "should prepend text to a file object" do
+      PrependFile.prepend(@file, "This is text")
+      File.read(@file_name).should eq("This is text\n#{@original_contents}")
+    end
+
+    it "should prepend a file from a given file location to a file given a file name" do
+      PrependFile.prepend(@file, "sample_files/prepend_data")
+      File.read(@file_name).should eq("#{File.read('sample_files/prepend_data')}#{@original_contents}")
+    end
+
+    it "should prepend a file from a given file object to a file given a file name" do
+      PrependFile.prepend(@file, File.new("sample_files/prepend_data"))
+      File.read(@file_name).should eq("#{File.read('sample_files/prepend_data')}#{@original_contents}")
+    end
+
+    it "should prepend a file from a given IO object to a file given a file name" do
+      PrependFile.prepend(@file, File.open("sample_files/prepend_data", 'r'))
+      File.read(@file_name).should eq("#{File.read('sample_files/prepend_data')}#{@original_contents}")
+    end
+
+  end
+
+
+  context "Dest File is a IO Object" do
+    before do
+      @file_name = "sample_files/sample.txt"
+      @file = File.open @file_name
+      @original_contents = @file.read
+      @file.rewind
+    end
+
+    after do
+      File.open(@file_name, 'w') {|f| f.write @original_contents}
+    end
+
+    it "should reach the end of the given source file" do
+      PrependFile.prepend(@file, "This is text")
+      @file.eof?.should eq(true)
+    end
+
+    it "should prepend text to a file object" do
+      PrependFile.prepend(@file, "This is text")
+      File.read(@file_name).should eq("This is text\n#{@original_contents}")
+    end
+
+    it "should prepend a file from a given file location to a file given a file name" do
+      PrependFile.prepend(@file, "sample_files/prepend_data")
+      File.read(@file_name).should eq("#{File.read('sample_files/prepend_data')}#{@original_contents}")
+    end
+
+    it "should prepend a file from a given file object to a file given a file name" do
+      PrependFile.prepend(@file, File.new("sample_files/prepend_data"))
+      File.read(@file_name).should eq("#{File.read('sample_files/prepend_data')}#{@original_contents}")
+    end
+
+    it "should prepend a file from a given IO object to a file given a file name" do
+      PrependFile.prepend(@file, File.open("sample_files/prepend_data", 'r'))
+      File.read(@file_name).should eq("#{File.read('sample_files/prepend_data')}#{@original_contents}")
+    end
+
+
+  end
+
+end

data/spec/sample_files/other_sample.txt

@@ -0,0 +1,3 @@
+This is a test document
+
+Please handle WITH LOTS OF LOVE AND CARE :)

data/spec/sample_files/prepend_data

@@ -0,0 +1,5 @@
+THIS SHOULD GO ON TOP
+
+Yea
+
+Ok

data/spec/sample_files/sample.txt

@@ -0,0 +1,5 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam ac congue orci. Donec consequat pellentesque nibh, at ullamcorper ligula feugiat id. Sed urna lorem, iaculis at lacinia ac, ultrices nec lacus. Suspendisse dapibus accumsan orci id gravida. Nulla ligula sem, porttitor quis tincidunt ut, commodo sed dui. Nam ac dolor id mauris fermentum tincidunt. Nullam tortor lacus, interdum a adipiscing a, volutpat vel diam. Vestibulum dapibus dignissim eros in sodales. Mauris scelerisque dignissim erat quis fringilla. Suspendisse aliquet lorem mauris. In hac habitasse platea dictumst. Phasellus sit amet ipsum augue, id mollis eros. Vivamus et augue sem, non ultricies elit. Suspendisse potenti. Suspendisse elementum felis ac diam imperdiet gravida.
+
+Sed euismod, turpis sed tristique scelerisque, justo nisl vestibulum lorem, id ultricies velit ante vitae neque. Phasellus ut mi nulla. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Aenean scelerisque lacinia vulputate. Nulla facilisi. Maecenas facilisis varius elementum. In hac habitasse platea dictumst. Donec egestas eros sit amet eros pulvinar volutpat. Fusce eget lorem id magna varius iaculis. In hac habitasse platea dictumst. Phasellus rutrum posuere dolor nec aliquam. Maecenas lobortis risus ut nunc ultrices volutpat. Praesent neque orci, fringilla sagittis molestie eget, hendrerit sed nisl.
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+f = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+require File.join(File.dirname(f), '..', 'lib', 'prependfile')
+
+def run_bin(args)
+  `../bin/prependfile #{args}`
+end
+
+def abs_sample_file_path(*files)
+  files.map{|f| "../spec/sample_files/#{f}"}
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: prependfile
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Mike Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Prepend any file with text (think licenses, copyright, ownership etc)
+email: 
+- ft.mikelewis@gmail.com
+executables: 
+- prependfile
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/prependfile
+- lib/prependfile.rb
+- lib/prependfile/version.rb
+- prependfile.gemspec
+- spec/bin_spec.rb
+- spec/prependfile_spec.rb
+- spec/sample_files/other_sample.txt
+- spec/sample_files/prepend_data
+- spec/sample_files/sample.txt
+- spec/spec_helper.rb
+homepage: http://github.com/mikelewis/prependfile
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: prependfile
+rubygems_version: 1.7.1
+signing_key: 
+specification_version: 3
+summary: Prepend any file with text (think licenses, copyright, ownership etc)
+test_files: 
+- spec/bin_spec.rb
+- spec/prependfile_spec.rb
+- spec/sample_files/other_sample.txt
+- spec/sample_files/prepend_data
+- spec/sample_files/sample.txt
+- spec/spec_helper.rb