shell-utils 0.0.1

data/lib/filename.rb

@@ -0,0 +1,61 @@
+class Filename
+	
+	DIR_SEPARATOR = '/'
+	WINDOWS_DIR_SEPARATOR = '\\'
+	
+	attr_accessor :path_items
+	
+	def initialize filename
+		filename = filename.gsub(WINDOWS_DIR_SEPARATOR, DIR_SEPARATOR)
+		@path_items = filename.split(DIR_SEPARATOR).delete_if{|item| item.empty?}
+		@absolute_path = filename.start_with? DIR_SEPARATOR
+	end
+	
+	def absolute_path?
+		@absolute_path
+	end
+	
+	def relative_path?
+		not absolute_path?
+	end
+	
+	def without_extension 
+		if @path_items.size > 0 and @path_items.last.include? '.' then
+			Filename.new(to_s.split('.')[0..-2].join('.'))
+		else
+			clone
+		end
+	end
+	
+	def extract_last_path_item
+		Filename.new(nil_to_empty_string @path_items.last)
+	end
+	
+	def remove_last_path_item
+		Filename.new(make_string(@path_items[0..-2]))
+	end
+	
+	def to_unix_s
+		make_string @path_items
+	end
+	
+	def to_windows_s
+		make_string @path_items, WINDOWS_DIR_SEPARATOR
+	end
+	
+	def to_s
+		to_unix_s
+	end
+	
+private
+	
+	def make_string the_path_items, seperator=DIR_SEPARATOR
+		prefix = absolute_path? ? seperator : ''
+		prefix + the_path_items.join(seperator)
+	end
+
+	def nil_to_empty_string object
+		object.nil? ? "" : object
+	end
+	
+end

data/lib/session_zipper.rb

@@ -0,0 +1,19 @@
+require 'zip/zip'
+require 'zip/zipfilesystem'
+
+class SessionZipper
+
+  def compress(path)
+	  path.sub!(%r[/$],'')
+	  archive = File.join(path,File.basename(path))+'.zip'
+	  FileUtils.rm archive, :force=>true
+
+	  Zip::ZipFile.open(archive, 'w') do |zipfile|
+	    Dir["#{path}/**/**"].reject{|f|f==archive}.each do |file|
+	      zipfile.add(file.sub(path+'/',''),file)
+	    end
+	  end
+	  archive
+	end	
+	
+end

data/lib/shell_argument_exception.rb

@@ -0,0 +1,9 @@
+class ShellArgumentException < Exception
+	
+	attr_accessor :command
+	
+	def initialize command
+		@command = command
+	end
+	
+end

data/lib/shell_process.rb

@@ -0,0 +1,5 @@
+class ShellProcess
+	
+	attr_accessor :output, :return_code
+	
+end

data/lib/shell_wrapper.rb

@@ -0,0 +1,161 @@
+require 'tempfile'
+require 'shell_process'
+require 'yaml'
+
+class ShellWrapper
+
+  MAX_STDOUT_LENGTH = 100000
+
+  def cp source, destination
+    FileUtils.cp source, destination
+  end
+
+  def cp_r source, destination
+    FileUtils.cp_r source, destination
+  end
+
+	def rm_r file_regex
+		files_in_dir_tree('.', file_regex).each do |file|
+			FileUtils.rm file
+		end
+	end
+
+  def mkdir dir
+    FileUtils.mkdir dir
+  end
+
+  def mkdir_p dirs
+    FileUtils.mkdir_p dirs
+  end
+
+	def rename old_filename, new_filename
+		File.rename old_filename, new_filename
+	end
+
+	def current_file
+		__FILE__
+	end
+
+  def execute command
+		process = ShellProcess.new 
+	  redirect_stderr_to_stdout = "2>&1"
+    spec_pipe = IO.popen("#{command} #{redirect_stderr_to_stdout}", "r")
+    process.output = spec_pipe.read MAX_STDOUT_LENGTH
+    spec_pipe.close
+		process.return_code = $?.exitstatus
+    puts process.output unless process.output.nil?
+    process
+  end
+
+  def write_file filename, content
+    file = File.new filename, "w"
+    file << content
+    file.close
+  end
+
+  def read_file filename
+    file = File.new filename
+    content = file.read
+    file.close
+    content
+  end
+
+  def creation_time filename
+    File.ctime(filename)
+  end
+
+  def modification_time filename
+    File.mtime(filename)
+  end
+
+	def real_dir_entries dir
+		Dir.new(dir).entries - ["..", "."]
+	end
+	
+	def files_in_dir dir, regexp_pattern=nil
+		Dir.new(dir).entries.find_all{|entry|
+			file_matches_regexp? entry, regexp_pattern
+		}
+	end
+	
+	def files_in_dir_tree dir, regexp_pattern=nil
+		Dir.glob("#{dir}/**/*").find_all{|entry|
+			file_matches_regexp? entry, regexp_pattern
+		}.sort
+	end
+
+	def file_matches_regexp? dir_entry, regexp_pattern
+		File.file?(dir_entry) and (not regexp_pattern or dir_entry =~ Regexp.new(regexp_pattern))
+	end
+		
+	
+	def newest_dir_entry dir, files=nil
+		unless files then files = real_dir_entries(dir) end
+		files.sort_by do |entry| 
+			complete_path = File.join dir, entry
+			File.mtime(complete_path)
+		end.last
+	end
+	
+  def file? filename
+		File.file? filename
+	end
+	
+	def open_with_default_app filename
+		execute "#{open_command_name} #{filename}"
+	end
+	
+	def read_properties filename
+		begin
+			YAML.load_file filename
+		rescue
+			raise PropertyFileMissingException.new filename
+		end
+	end
+	
+	def remove_command_name
+		windows? ? 'del' : 'rm'
+	end
+	
+	def open_command_name
+		if windows? then
+			'start'
+		elsif mac? then
+			'open'
+		else
+			'xdg-open'
+		end
+	end
+
+	def expand_run_command command
+		if command.end_with?(".sh") then
+			"bash #{command}"
+		else
+			command
+		end
+	end
+
+	def shell_extension
+		windows? ? 'cmd' : 'sh'
+	end
+	
+	def path_separator
+		windows? ? ';' : ':'
+	end
+	
+	def dir_separator
+		File::ALT_SEPARATOR ? File::ALT_SEPARATOR : File::SEPARATOR
+	end
+	
+	def windows?
+		platform = RUBY_PLATFORM.downcase
+		platform.include?("windows") or platform.include?("mingw32")
+	end
+
+	def mac?
+		platform = RUBY_PLATFORM.downcase
+		platform.include?("universal-darwin")
+	end
+
+end
+

data/spec/filename_spec.rb

@@ -0,0 +1,69 @@
+require 'filename'
+
+describe Filename do
+
+  it "should detect if the path is absolute or relative" do
+		Filename.new('').absolute_path?.should be_false
+		Filename.new('/').absolute_path?.should be_true
+		Filename.new('').relative_path?.should be_true
+		Filename.new('/').relative_path?.should be_false
+  end
+
+  it "should split into path items" do
+		Filename.new('').path_items.should == []
+		Filename.new('a').path_items.should == ['a']
+		Filename.new('/a').path_items.should == ['a']
+		Filename.new('/a/').path_items.should == ['a']
+		Filename.new('a/b').path_items.should == ['a', 'b']
+		Filename.new('/a/b').path_items.should == ['a', 'b']
+	end
+	
+	it "should remove the extension" do
+		Filename.new('').without_extension.to_s.should == ''
+		Filename.new('a').without_extension.to_s.should == 'a'
+		Filename.new('a.b').without_extension.to_s.should == 'a'
+		Filename.new('a.b.c').without_extension.to_s.should == 'a.b'
+		Filename.new('a.b/c').without_extension.to_s.should == 'a.b/c'
+	end
+	
+	it 'should remove the last element of a dir path' do
+		Filename.new('').remove_last_path_item.to_s.should == ""
+		Filename.new('/').remove_last_path_item.to_s.should == "/"
+		Filename.new('a').remove_last_path_item.to_s.should == ""
+		Filename.new('a/').remove_last_path_item.to_s.should == ""
+	  Filename.new('/a').remove_last_path_item.to_s.should == "/"
+	  Filename.new('/a/').remove_last_path_item.to_s.should == "/"
+		Filename.new('a/b').remove_last_path_item.to_s.should == "a"
+	end
+	
+	it 'should extract the last element of a dir path' do
+		Filename.new('').extract_last_path_item.to_s.should == ""
+		Filename.new('/').extract_last_path_item.to_s.should == ""
+		Filename.new('a').extract_last_path_item.to_s.should == "a"
+		Filename.new('a/b/').extract_last_path_item.to_s.should == "b"
+		Filename.new('a/b/c').extract_last_path_item.to_s.should == "c"
+  end
+
+	it "should return a Unix like string representation" do
+		Filename.new('a/b').to_unix_s.should == 'a/b'
+		Filename.new('/a/b').to_unix_s.should == '/a/b'
+		Filename.new('a\\b').to_unix_s.should == 'a/b'
+		Filename.new('\\a\\b').to_unix_s.should == '/a/b'
+		Filename.new('a/').to_unix_s.should == 'a'
+	end
+
+	it "should return a Windows like string representation" do
+		Filename.new('a/b').to_windows_s.should == 'a\\b'
+		Filename.new('/a/b').to_windows_s.should == '\\a\\b'
+		Filename.new('a\\b').to_windows_s.should == 'a\\b'
+		Filename.new('\\a\\b').to_windows_s.should == '\\a\\b'
+	end
+
+	it "should return a Unix like string representation by default" do
+		Filename.new('/a/b').to_s.should == '/a/b'
+		Filename.new('a\\b').to_s.should == 'a/b'
+	end
+
+end
+
+

data/spec/shell_wrapper_spec.rb

@@ -0,0 +1,61 @@
+require 'shell_wrapper'
+
+describe ShellWrapper do
+
+	before (:each) do
+		@shell = ShellWrapper.new
+  end
+
+	it "should return the files in a directory" do
+		Dir.should_receive(:new).with('myDir').and_return ['file1', 'dir', 'file2']
+		File.should_receive(:file?).with('file1').and_return true
+		File.should_receive(:file?).with('dir').and_return false
+		File.should_receive(:file?).with('file2').and_return true
+		@shell.files_in_dir('myDir').should == ['file1', 'file2']
+	end
+	
+	it "should filter files by regex pattern" do
+		Dir.should_receive(:new).with('myDir').and_return ['file1.rb', 'file2.py']
+		File.should_receive(:file?).any_number_of_times.and_return true
+		@shell.files_in_dir('myDir', '.*\.rb').should == ['file1.rb']
+	end
+	
+	it "should filter files by regex pattern recursivly and sort result alphabetically" do
+		Dir.should_receive(:glob).with('myDir/**/*').and_return ['file3.rb', 'file2.rb', 'file1.py']
+		File.should_receive(:file?).any_number_of_times.and_return true
+		@shell.files_in_dir_tree('myDir', '.*\.rb').should == ['file2.rb', "file3.rb"]
+	end
+
+	it "should omit . and .. from dir list" do
+		Dir.should_receive(:new).and_return ['.', '..', 'bar', 'bar2']
+		@shell.real_dir_entries('foo').should == ['bar', 'bar2']
+	end
+
+	it "should omit . and .. when retrieving the newest file in a directory" do
+		Dir.should_receive(:new).and_return ['.', '..', 'bar', 'bar2']
+		File.should_receive(:mtime).with('foo/bar').and_return 2
+		File.should_receive(:mtime).with('foo/bar2').and_return 1
+		@shell.newest_dir_entry('foo').should == "bar"
+	end
+	
+	it "should retrieve the newest dir from a file list" do
+		File.should_receive(:mtime).with('foo/bar/file1').and_return 2
+		File.should_receive(:mtime).with('foo/file2').and_return 1
+		@shell.newest_dir_entry('foo', ['bar/file1', 'file2']).should == 'bar/file1'
+	end
+	
+	it "should prepend *.sh start scripts with 'bash'" do
+		@shell.expand_run_command('aCommand.sh').should == 'bash aCommand.sh'
+	end
+	
+	it "should not prepend *.bat start scripts with anything" do
+		@shell.expand_run_command('aCommand.bat').should == 'aCommand.bat'
+	end
+	
+	it "should not prepend *.cmd start scripts with anything" do
+		@shell.expand_run_command('aCommand.cmd').should == 'aCommand.cmd'
+	end
+	
+	
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: shell-utils
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- CodersDojo-Team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 4
+        version: 0.9.4
+  type: :runtime
+  version_requirements: *id001
+description: Shell utilities.
+email: codersdojo@it-agile.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/filename.rb
+- lib/session_zipper.rb
+- lib/shell_argument_exception.rb
+- lib/shell_process.rb
+- lib/shell_wrapper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: shell_utils
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Shell Utilities
+test_files: 
+- spec/filename_spec.rb
+- spec/shell_wrapper_spec.rb