utilitypack 0.5.1

data/CHANGELOG

@@ -0,0 +1,4 @@
+= 0.1
+== 2008-01-19
+* Initial version
+* Project structure in place and a bit of functionality

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Brian Pfeil
+
+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 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

@@ -0,0 +1,7 @@
+= Utility Pack
+
+Utility pack provides a myriad of utilities for general development.
+
+== Utility Pack
+
+blah blah blah ...

data/Rakefile

@@ -0,0 +1,94 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+
+# get version info from source file
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'utility_pack/version'
+
+windows = (PLATFORM =~ /win32|cygwin/)
+BAT = windows ? ".bat" : ""
+SUDO = windows ? "" : "sudo"
+
+PKG_NAME = "utilitypack"
+PKG_VERSION = UtilityPack::VERSION::STRING
+CLEAN.include ['*.gem', 'pkg/', 'doc/rdoc']
+RDOC_OPTS = ['--quiet', '--title', "Utility Pack",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+# Test Tasks ---------------------------------------------------------
+
+desc "Run all tests"
+task :test_all => [:test_units]
+task :ta => [:test_all]
+
+task :tu => [:test_units]
+
+Rake::TestTask.new("test_units") do |t|
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = false
+end
+
+
+
+desc "Packages up Utility Pack."
+task :default => [:package]
+
+desc "creates package"
+task :package => [:clean]
+
+desc "creates documentation"
+task :doc => [:rdoc]
+
+Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'doc/rdoc'
+    rdoc.options += RDOC_OPTS
+    rdoc.main = "README"
+    rdoc.title = "Utility Pack"
+    rdoc.rdoc_files.add ['README', 'CHANGELOG', 'COPYING', 'lib/**/*.rb']
+end
+
+spec =
+    Gem::Specification.new do |s|
+        s.name = PKG_NAME
+        s.version = PKG_VERSION
+        s.platform = Gem::Platform::RUBY
+        s.has_rdoc = true
+        s.extra_rdoc_files = ["README", "CHANGELOG", "COPYING"]
+        s.rdoc_options = RDOC_OPTS
+        s.summary = "Library of useful utilities"
+        s.description = s.summary
+        s.author = "Brian Pfeil"
+        s.email = 'brian.pfeil@gmail.com'
+        s.homepage = 'http://brianpfeil.com'
+        #s.executables = ['desktopsearch']
+        s.required_ruby_version = '>= 1.8.2'
+        s.files = %w(COPYING README Rakefile) +
+          Dir.glob("{bin,doc,test,lib,examples,extras,share,contrib}/**/*") + 
+          Dir.glob("ext/**/*.{h,c,rb}") +
+          Dir.glob("examples/**/*.rb") +
+          Dir.glob("tools/*.rb")
+        s.require_path = "lib"
+        s.bindir = "bin"
+    end
+
+Rake::GemPackageTask.new(spec) do |p|
+    p.need_tar = false
+    p.need_zip = false
+    p.gem_spec = spec
+end
+
+desc "installs gem"
+task :install => [:package] do
+  sh %{gem#{BAT} install pkg/#{PKG_NAME}-#{PKG_VERSION}}
+end
+
+desc "uninstalls gem"
+task :uninstall => [:clean] do
+  sh %{#{SUDO} gem#{BAT} uninstall #{PKG_NAME} -x}
+end

data/examples/7zip.rb

@@ -0,0 +1,27 @@
+require 'fileutils'
+require 'utility_pack'
+
+include FileUtils
+
+def run archive_path, paths, type
+  puts "Deleting #{archive_path}"
+  rm_f archive_path
+  if File.exists?(archive_path)
+    puts "Failed to delete #{archive_path}.  Exiting."
+    exit
+  else
+    puts "Successfully deleted #{archive_path}"
+  end
+
+  UtilityPack::SevenZip.send(type, archive_path, paths) 
+  puts "Size of #{archive_path} is #{File.stat(archive_path).size/(1024.0*1024.0)} MB"
+end
+
+paths = [["c:\\temp\\ifb"], "C:\\Program Files\\7-Zip"]
+
+# create regular zip file
+run "c:\\temp\\a.zip", paths, :zip
+
+# create self extracting file
+run "c:\\temp\\a.exe", paths, :sfx
+

data/examples/rar.rb

@@ -0,0 +1,26 @@
+require 'fileutils'
+require 'utility_pack'
+
+include FileUtils
+
+def run archive_path, paths, type
+  puts "Deleting #{archive_path}"
+  rm_f archive_path
+  if File.exists?(archive_path)
+    puts "Failed to delete #{archive_path}.  Exiting."
+    exit
+  else
+    puts "Successfully deleted #{archive_path}"
+  end
+
+  UtilityPack::Rar.send(type, archive_path, paths) 
+  puts "Size of #{archive_path} is #{File.stat(archive_path).size/(1024.0*1024.0)} MB"
+end
+
+paths = [["c:\\temp\\ifb"], "C:\\Program Files\\7-Zip"]
+
+# create regular zip file
+run "c:\\temp\\a.rar", paths, :rar
+
+# create self extracting file
+run "c:\\temp\\a.exe", paths, :sfx

data/lib/utility_pack.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'utility_pack/datetime'
+require 'utility_pack/core_ext'
+require 'utility_pack/win32'
+require 'utility_pack/rar'
+require 'utility_pack/7zip'
+require 'utility_pack/ie'

data/lib/utility_pack/7zip.rb

@@ -0,0 +1,18 @@
+module UtilityPack
+  # Wrapper around the rar archiving and compression utility
+  module SevenZip
+    include UtilityPack::Win32
+
+    # creates a 7-zip archive for the specified files/directories
+    # archive_path - archive file that'll be created
+    # *paths - files/directories to archive
+    def self.zip archive_path, *paths
+      CoreHelpers.s "7za a -tzip \"#{archive_path}\" " +paths.flatten.collect{|p| "\"#{p}\""}.join(' ')
+    end
+    
+    def self.sfx archive_path, *paths
+      CoreHelpers.s "7za a -sfx7z.sfx \"#{archive_path}\" " +paths.flatten.collect{|p| "\"#{p}\""}.join(' ')
+    end
+    
+  end
+end

data/lib/utility_pack/core_ext.rb

@@ -0,0 +1,4 @@
+Dir[File.dirname(__FILE__) + "/core_ext/*.rb"].sort.each do |path|
+  filename = File.basename(path)
+  require "utility_pack/core_ext/#{filename}"
+end

data/lib/utility_pack/core_ext/array.rb

@@ -0,0 +1,36 @@
+module UtilityPack
+  module CoreExtensions
+    module Array
+      
+      # returns a random element from the array
+      # if count is specified, a array of unique random elements is returned
+      def random(count = 1)
+        
+        raise "Invalid argument (count must be >1)" if count < 1
+        
+        if count == 1
+          self[rand(self.size)]
+        else
+          raise "Invalid argument.  The size of the array is #{self.size} and \
+            you are requesting #{count} random elements" if count > self.size
+          
+          r = []
+          while r.size != count
+            tmp = self[rand(self.size)]
+            r << tmp unless r.include?(tmp)
+          end
+          
+          if count == 1
+            r = r[0]
+          end
+          r
+        end
+      end
+      
+    end
+  end
+end
+
+class Array #:nodoc:
+  include UtilityPack::CoreExtensions::Array
+end

data/lib/utility_pack/core_ext/file.rb

@@ -0,0 +1,27 @@
+module UtilityPack
+  module CoreExtensions
+    module File
+      
+      module InstanceMethods
+      end
+      
+      module ClassMethods
+          
+        def read_file(path)
+          ::File.open(path, 'r') {|f| f.read }
+        end
+
+        def write_file(path, s)
+          ::File.open(path, 'w') {|f| f.write(s) }
+        end
+      
+      end
+      
+    end
+  end
+end
+
+class File #:nodoc:
+  include UtilityPack::CoreExtensions::File::InstanceMethods
+  extend UtilityPack::CoreExtensions::File::ClassMethods
+end

data/lib/utility_pack/core_ext/hash.rb

@@ -0,0 +1,25 @@
+module UtilityPack
+  module CoreExtensions
+    module Hash
+      
+      module InstanceMethods
+      end
+      
+      module ClassMethods
+          
+        def transform_keys_to_symbols(value)
+          return value if not value.is_a?(::Hash)
+          hash = value.inject({}){|memo,(k,v)| memo[k.to_sym] = self.transform_keys_to_symbols(v); memo}
+          return hash
+        end
+      
+      end
+      
+    end
+  end
+end
+
+class Hash #:nodoc:
+  include UtilityPack::CoreExtensions::Hash::InstanceMethods
+  extend UtilityPack::CoreExtensions::Hash::ClassMethods
+end

data/lib/utility_pack/core_ext/string.rb

@@ -0,0 +1,21 @@
+module UtilityPack
+  module CoreExtensions
+    module String
+     
+      # returns a new string instance populated with the provided variable values.
+      # template variables are of the form :<variable name>. e.g. :name
+      def fill(values = {})
+        s = self.clone
+        values.each do |key, value|
+          s.gsub!(":#{key}", value.to_s) if value.respond_to? :to_s
+        end
+        s  
+      end
+      
+    end
+  end
+end
+
+class String #:nodoc:
+  include UtilityPack::CoreExtensions::String
+end

data/lib/utility_pack/datetime.rb

@@ -0,0 +1,27 @@
+module UtilityPack
+  module DateTimeHelpers
+
+    class HourMinSec < Time
+      
+      def <=>(other)
+        # only compare based on hour, minutes, and seconds (leave date portion off)
+        self_seconds = (self.hour * (60 * 60)) + (self.min * 60) + self.sec
+        other_seconds = (other.hour * (60 * 60)) + (other.min * 60) + other.sec
+
+        if self_seconds < other_seconds
+          return -1
+        elsif self_seconds == other_seconds
+            return 0
+        else
+          return 1
+        end
+      end
+    
+    end
+  
+    def self.timestamp_for_filename
+      Time.now.strftime("%Y-%m-%d_%H.%M.%S")
+    end
+    
+  end
+end

data/lib/utility_pack/ie.rb

@@ -0,0 +1,19 @@
+require 'fileutils'
+
+module UtilityPack
+  module InternetExplorerHelpers
+    include UtilityPack::Win32
+    
+    CACHE_DIRECTORIES = [
+        "c:/windows/Temporary Internet Files",
+        "C:/Documents and Settings/#{ENV['USERNAME']}/Local Settings/Temporary Internet Files"
+      ]
+    
+    def self.clear_cache
+      CACHE_DIRECTORIES.each do |dir|
+        FileHelpers.delete Dir["#{dir}/**/*"] if File.exists?(dir)
+      end
+    end
+    
+  end
+end

data/lib/utility_pack/persistenthash.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'json/pure'
+require 'utility_pack/core_ext/file'
+
+module UtilityPack
+
+  class PersistentHash
+    def initialize path
+      @path = path
+    end
+  
+    def json_parse_file(path)
+      JSON.parse(File.read_file(path))
+    end
+
+    def load
+      File.exists?(@path) ? json_parse_file(@path) : {}
+    end
+  
+    def save h
+      File.write_file @path, h.to_json
+    end
+
+    def [](key)
+       load[key]
+    end
+
+    def []=(key, value)
+      h = load
+      h[key] = value
+      save(h)
+    end  
+  
+  end
+
+end

data/lib/utility_pack/rar.rb

@@ -0,0 +1,18 @@
+module UtilityPack
+  # Wrapper around the rar archiving and compression utility
+  module Rar
+    include UtilityPack::Win32
+
+    # creates a rar archive for the specified files/directories
+    # archive_path - archive file that'll be created
+    # *paths - files/directories to archive
+    def self.rar archive_path, *paths
+      CoreHelpers.s "rar a -m5 \"#{archive_path}\" " +paths.flatten.collect{|p| "\"#{p}\""}.join(' ')
+    end
+    
+    def self.sfx archive_path, *paths
+      CoreHelpers.s "rar a -sfx \"#{archive_path}\" " +paths.flatten.collect{|p| "\"#{p}\""}.join(' ')
+    end    
+    
+  end
+end

data/lib/utility_pack/version.rb

@@ -0,0 +1,9 @@
+module UtilityPack
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 5
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/utility_pack/win32.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# NOTE: order of requires is important
+%w( core process shell file ).each { |f| require "utility_pack/win32/#{f}_helpers" }

data/lib/utility_pack/win32/core_helpers.rb

@@ -0,0 +1,11 @@
+module UtilityPack
+  module Win32
+    module CoreHelpers
+      
+      def self.s(*argv)
+        system(*argv)
+      end      
+      
+    end
+  end
+end

data/lib/utility_pack/win32/file_helpers.rb

@@ -0,0 +1,35 @@
+require 'fileutils'
+
+module UtilityPack
+  module Win32
+    module FileHelpers
+      
+      MAX_DELETE_FILE_RETRIES = 20
+      
+      def delete_file path
+        count = 0
+        while File.exist?(path) && count < MAX_DELETE_FILE_RETRIES do
+          puts "Deleting file #{path}"
+          rm_f path
+          count = count + 1
+        end
+      end
+      
+      def delete_directory path
+        puts "Deleting directory #{path}"
+        rm_rf path if File.directory?(path)
+      end
+      
+      def delete(*args)
+        args.flatten.each do |path|
+          delete_file path unless File.directory?(path)
+          delete_directory path if File.directory?(path)
+        end
+      end
+      
+      # add all instance methods as singleton methods also
+      self.extend(self)
+      include FileUtils
+    end
+  end
+end

data/lib/utility_pack/win32/process_helpers.rb

@@ -0,0 +1,14 @@
+module UtilityPack
+  module Win32
+    module ProcessHelpers
+      include UtilityPack::Win32
+      
+      def self.kill(*images)
+        images.flatten.each do |image|
+          CoreHelpers.s "taskkill /IM #{image} /F /T"
+        end
+      end      
+ 
+    end
+  end
+end

data/lib/utility_pack/win32/shell_helpers.rb

@@ -0,0 +1,32 @@
+module UtilityPack
+  module Win32
+    module ShellHelpers
+      include UtilityPack::Win32::CoreHelpers
+      
+      def cmd_then_exit(cmd, *options)
+        options << "/c"
+        s "cmd #{options.join(' ')} #{cmd}"
+      end  
+
+      def cmd_then_remain(cmd, *options)
+        options << "/k"
+        s "cmd #{options.join(' ')} #{cmd}"
+      end  
+
+      def start_async(cmd, *options)
+        s "cmd /c start \"\" #{options.join(' ')} #{cmd}"
+      end  
+
+      def start_and_wait(cmd, *options)
+        options << "/wait"
+        start_async(cmd, options)
+      end    
+
+      def cmd_prompt_here(*options)
+        directory_path = ENV['dir']  || ''
+        cmd_then_remain "(cd /d #{directory_path} & cls)", options  
+      end
+ 
+    end
+  end
+end

data/test/test_core_extensions_array.rb

@@ -0,0 +1,21 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'utility_pack/core_ext/array'
+
+class TestCoreExtensionsArray < Test::Unit::TestCase
+  
+  def test_random
+    # functional
+    assert([1].random == 1)
+    assert([].random == nil)
+    assert([1].random(1) == 1)
+    assert([1,2,3].random(3).sort == [1,2,3])
+  
+    # bounds checking
+    assert_raise(RuntimeError) { [1].random(0) }
+    assert_raise(RuntimeError) { [1].random(-1) }
+    assert_raise(RuntimeError) { [1].random(2) }
+  end
+  
+end

data/test/test_core_extensions_file.rb

@@ -0,0 +1,27 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'utility_pack/core_ext/file'
+
+require 'tempfile'
+
+
+class TestCoreExtensionsFile < Test::Unit::TestCase
+
+  def test_write_file
+    s = "hello world"
+    file = Tempfile.new('test_write_file')
+    File.write_file(file.path, s)
+    assert_equal s, File.open(file.path) {|f| f.read}
+  end
+
+  
+  def test_read_file
+    s = "hello world"
+    file = Tempfile.new('test_read_file')
+    file.write(s)
+    file.close      
+    assert_equal s, File.read_file(file.path)
+  end
+  
+end

data/test/test_core_extensions_hash.rb

@@ -0,0 +1,15 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'utility_pack/core_ext/hash'
+
+class TestCoreExtensionsHash < Test::Unit::TestCase
+  
+  def test_transform_keys_to_symbols
+    h1 = {'name' => 'brian', 'age' => 33, 'son' => {'name', 'wyatt'}}
+    h2 = Hash.transform_keys_to_symbols(h1)
+    assert_equal h1['name'], h2[:name]
+    assert_equal 'wyatt', h2[:son][:name]
+  end
+  
+end

data/test/test_core_extensions_string.rb

@@ -0,0 +1,13 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'utility_pack/core_ext/string'
+
+class TestCoreExtensionsString < Test::Unit::TestCase
+  
+  def test_fill
+    assert_equal "hello world", "hello :name".fill(:name => 'world')
+    assert_equal "1 2 3 3 2 1", ":one 2 3 3 2 :one".fill(:one => '1')
+  end
+  
+end

data/test/test_persistenthash.rb

@@ -0,0 +1,20 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'utility_pack/persistenthash'
+
+class TestPersistentHash < Test::Unit::TestCase
+  include UtilityPack
+  
+  def test_save
+    file = Tempfile.new('test_save')
+    path = file.path
+    file.close
+    file.unlink
+    ph = PersistentHash.new(path)
+    value = 'brian'
+    ph[:name] = {:value => value}
+    assert_equal ph['name']['value'], value
+  end
+  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: utilitypack
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
+platform: ruby
+authors: 
+- Brian Pfeil
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-06 01:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Library of useful utilities
+email: brian.pfeil@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGELOG
+- COPYING
+files: 
+- COPYING
+- README
+- Rakefile
+- test/test_core_extensions_array.rb
+- test/test_core_extensions_file.rb
+- test/test_core_extensions_hash.rb
+- test/test_core_extensions_string.rb
+- test/test_persistenthash.rb
+- lib/utility_pack/7zip.rb
+- lib/utility_pack/core_ext/array.rb
+- lib/utility_pack/core_ext/file.rb
+- lib/utility_pack/core_ext/hash.rb
+- lib/utility_pack/core_ext/string.rb
+- lib/utility_pack/core_ext.rb
+- lib/utility_pack/datetime.rb
+- lib/utility_pack/ie.rb
+- lib/utility_pack/persistenthash.rb
+- lib/utility_pack/rar.rb
+- lib/utility_pack/version.rb
+- lib/utility_pack/win32/core_helpers.rb
+- lib/utility_pack/win32/file_helpers.rb
+- lib/utility_pack/win32/process_helpers.rb
+- lib/utility_pack/win32/shell_helpers.rb
+- lib/utility_pack/win32.rb
+- lib/utility_pack.rb
+- examples/7zip.rb
+- examples/rar.rb
+- CHANGELOG
+has_rdoc: true
+homepage: http://brianpfeil.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --title
+- Utility Pack
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 2
+      version: 1.8.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Library of useful utilities
+test_files: []
+