nuggets 0.9.9 → 1.0.0

data/lib/nuggets/env/user_home_mixin.rb

@@ -0,0 +1,56 @@
+#--
+###############################################################################
+#                                                                             #
+# nuggets -- Extending Ruby                                                   #
+#                                                                             #
+# Copyright (C) 2007-2011 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# nuggets is free software; you can redistribute it and/or modify it under    #
+# the terms of the GNU Affero General Public License as published by the Free #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# nuggets is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with nuggets. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+module Nuggets
+  module Env
+    module UserHomeMixin
+
+  # call-seq:
+  #   ENV.user_home([default]) => aString
+  #
+  # Returns the user's home directory, or +default+ if it could not be found.
+  def user_home(default = ::File::ALT_SEPARATOR ? 'C:/' : '/')
+    begin
+      return ::Dir.home
+    rescue ::ArgumentError
+      # "couldn't find HOME environment -- expanding `~'"
+    end if ::Dir.respond_to?(:home)
+
+    %w[HOME HOMEDRIVE:HOMEPATH USERPROFILE APPDATA].each { |key|
+      home = values_at(*key.split(':')).join
+      return home.gsub(/\\/, '/') if home && !home.empty?
+    }
+
+    begin
+      ::File.expand_path('~')
+    rescue ::ArgumentError
+      default
+    end
+  end
+
+    end
+  end
+end

data/lib/nuggets/file/ext.rb

@@ -0,0 +1,5 @@
+require 'nuggets/file/ext_mixin'
+
+class File
+  extend Nuggets::File::ExtMixin
+end

data/lib/nuggets/file/ext_mixin.rb

@@ -0,0 +1,87 @@
+#--
+###############################################################################
+#                                                                             #
+# nuggets -- Extending Ruby                                                   #
+#                                                                             #
+# Copyright (C) 2007-2012 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# nuggets is free software; you can redistribute it and/or modify it under    #
+# the terms of the GNU Affero General Public License as published by the Free #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# nuggets is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with nuggets. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+module Nuggets
+  class File
+    module ExtMixin
+
+      # call-seq:
+      #   File.chomp_ext(path) -> aString
+      #
+      # Returns a copy of +path+ with its file extension removed.
+      def chomp_ext(path, ext = extname(path))
+        path.chomp(ext)
+      end
+
+      # call-seq:
+      #   File.chomp_ext!(path) -> aString | nil
+      #
+      # Modifies +path+ in place as described for #chomp_ext, returning
+      # +path+, or +nil+ if no modifications were made.
+      def chomp_ext!(path, ext = extname(path))
+        path.chomp!(ext)
+      end
+
+      # call-seq:
+      #   File.sub_ext(path, new_ext) -> aString
+      #
+      # Returns a copy of +path+ with its file extension replaced
+      # with +new_ext+ (if present; see also #set_ext).
+      def sub_ext(path, new_ext, ext = extname(path))
+        sub_ext!(_path = path.dup, new_ext, ext); _path
+      end
+
+      # call-seq:
+      #   File.sub_ext!(path, new_ext) -> aString | nil
+      #
+      # Modifies +path+ in place as described for #sub_ext, returning
+      # +path+, or +nil+ if no modifications were made.
+      def sub_ext!(path, new_ext, ext = extname(path))
+        path << new_ext if chomp_ext!(path, ext)
+      end
+
+      # call-seq:
+      #   File.set_ext(path, new_ext) -> aString
+      #
+      # Returns a copy of +path+ with its file extension removed
+      # and +new_ext+ appended. Like #sub_ext, but also applies
+      # when file extension is not present.
+      def set_ext(path, new_ext, ext = extname(path))
+        chomp_ext(path, ext) << new_ext
+      end
+
+      # call-seq:
+      #   File.set_ext!(path, new_ext) -> aString
+      #
+      # Modifies +path+ in place as described for #set_ext, returning
+      # +path+.
+      def set_ext!(path, new_ext, ext = extname(path))
+        chomp_ext!(path, ext); path << new_ext
+      end
+
+    end
+  end
+end

data/lib/nuggets/file/replace.rb

@@ -0,0 +1,5 @@
+require 'nuggets/file/replace_mixin'
+
+class File
+  extend Nuggets::File::ReplaceMixin
+end

data/lib/nuggets/file/replace_mixin.rb

@@ -0,0 +1,55 @@
+#--
+###############################################################################
+#                                                                             #
+# nuggets -- Extending Ruby                                                   #
+#                                                                             #
+# Copyright (C) 2007-2011 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# nuggets is free software; you can redistribute it and/or modify it under    #
+# the terms of the GNU Affero General Public License as published by the Free #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# nuggets is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with nuggets. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+module Nuggets
+  class File
+    module ReplaceMixin
+
+  # call-seq:
+  #   File.replace(name[, create_if_missing]) { ... } => aString
+  #   File.replace(name[, create_if_missing]) { |content| ... } => aString
+  #
+  # Replaces the contents of file +name+ with the result of the block. Yields
+  # the file's contents to the block if requested. Returns the new content.
+  #
+  # If +create_if_missing+ is +true+ and the file does not exist, it will be
+  # created.
+  def replace(name, create_if_missing = false, &block)
+    open(name, create_if_missing && !exist?(name) ? 'w+' : 'r+') { |f|
+      content = block.arity != 0 ? yield(f.read) : yield
+
+      f.truncate(0)
+      f.rewind
+
+      f.print content
+
+      content
+    }
+  end
+
+    end
+  end
+end

data/lib/nuggets/file/sub.rb

@@ -0,0 +1,5 @@
+require 'nuggets/file/sub_mixin'
+
+class File
+  extend Nuggets::File::SubMixin
+end

data/lib/nuggets/file/sub_mixin.rb

@@ -0,0 +1,95 @@
+#--
+###############################################################################
+#                                                                             #
+# nuggets -- Extending Ruby                                                   #
+#                                                                             #
+# Copyright (C) 2007-2011 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# nuggets is free software; you can redistribute it and/or modify it under    #
+# the terms of the GNU Affero General Public License as published by the Free #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# nuggets is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with nuggets. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+require 'nuggets/file/replace_mixin'
+
+module Nuggets
+  class File
+    module SubMixin
+
+  def self.extended(base)
+    base.extend Nuggets::File::ReplaceMixin
+  end
+
+  # call-seq:
+  #   File.sub(name, *args, &block) => aString
+  #
+  # Calls String#sub! on file +name+'s contents with +args+ and (optional)
+  # +block+ and returns the new content.
+  def sub(name, *args)
+    content = read(name)
+    content.sub!(*args, &block_given? ? ::Proc.new : nil)
+    content
+  end
+
+  # call-seq:
+  #   File.sub!(name, *args, &block) => aString or +nil+
+  #
+  # Calls String#sub! on file +name+'s contents with +args+ and (optional)
+  # +block+ and replaces the file with the new content. Returns the result
+  # of the String#sub! call.
+  def sub!(name, *args)
+    res = nil
+
+    replace(name) { |content|
+      res = content.sub!(*args, &block_given? ? ::Proc.new : nil)
+      content
+    }
+
+    res
+  end
+
+  # call-seq:
+  #   File.gsub(name, *args, &block) => aString
+  #
+  # Calls String#gsub! on file +name+'s contents with +args+ and (optional)
+  # +block+ and returns the new content.
+  def gsub(name, *args)
+    content = read(name)
+    content.gsub!(*args, &block_given? ? ::Proc.new : nil)
+    content
+  end
+
+  # call-seq:
+  #   File.gsub!(name, *args, &block) => aString or +nil+
+  #
+  # Calls String#gsub! on file +name+'s contents with +args+ and (optional)
+  # +block+ and replaces the file with the new content. Returns the result
+  # of the String#gsub! call.
+  def gsub!(name, *args)
+    res = nil
+
+    replace(name) { |content|
+      res = content.gsub!(*args, &block_given? ? ::Proc.new : nil)
+      content
+    }
+
+    res
+  end
+
+    end
+  end
+end

data/lib/nuggets/file/which.rb

@@ -0,0 +1,5 @@
+require 'nuggets/file/which_mixin'
+
+class File
+  extend Nuggets::File::WhichMixin
+end

data/lib/nuggets/file/which_mixin.rb

@@ -0,0 +1,72 @@
+#--
+###############################################################################
+#                                                                             #
+# nuggets -- Extending Ruby                                                   #
+#                                                                             #
+# Copyright (C) 2007-2011 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# nuggets is free software; you can redistribute it and/or modify it under    #
+# the terms of the GNU Affero General Public License as published by the Free #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# nuggets is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with nuggets. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+require 'rbconfig'
+
+module Nuggets
+  class File
+    module WhichMixin
+
+  DEFAULT_EXTENSIONS = [::RbConfig::CONFIG['EXEEXT']]
+
+  # call-seq:
+  #   File.which(executable[, extensions]) => aString or +nil+
+  #
+  # Returns +executable+ if it's executable, or the full path to +executable+
+  # found in PATH, or +nil+ otherwise. Checks +executable+ with each extension
+  # in +extensions+ appended in turn.
+  #
+  # Inspired by Gnuplot.which -- thx, Gordon!
+  def which(executable, extensions = DEFAULT_EXTENSIONS)
+    extensions |= ['']
+
+    if env = ::ENV['PATH']
+      dirs = env.split(self::PATH_SEPARATOR)
+      dirs.map! { |dir| expand_path(dir) }
+    end
+
+    extensions.find { |extension|
+      file = "#{executable}#{extension}"
+      return file if file?(file) && executable?(file)
+
+      dirs.find { |dir|
+        path = join(dir, file)
+        return path if file?(path) && executable?(path)
+      } if dirs
+    }
+  end
+
+  # call-seq:
+  #   File.which_command(commands) => aString or +nil+
+  #
+  # Returns the first of +commands+ that is executable (according to #which).
+  def which_command(commands, extensions = DEFAULT_EXTENSIONS)
+    commands.find { |command| which(command.to_s[/\S+/], extensions) }
+  end
+
+    end
+  end
+end

data/lib/nuggets/hash/at.rb

@@ -0,0 +1,68 @@
+#--
+###############################################################################
+#                                                                             #
+# nuggets -- Extending Ruby                                                   #
+#                                                                             #
+# Copyright (C) 2007-2011 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# nuggets is free software; you can redistribute it and/or modify it under    #
+# the terms of the GNU Affero General Public License as published by the Free #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# nuggets is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with nuggets. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+require 'nuggets/array/rand'
+
+class Hash
+
+  # call-seq:
+  #   hash.at(what) => aHash
+  #
+  # Returns the key/value pair of _hash_ at key position +what+. Remember that
+  # hashes might not have the intended (or expected) order in pre-1.9 Ruby.
+  def at(what, &block)
+    return {} if empty?
+
+    key = what.is_a?(::Integer) ? keys[what] : keys.send(*what, &block)
+
+    { key => self[key] }
+  end
+
+  # call-seq:
+  #   hash.first => aHash
+  #
+  # Returns the "first" key/value pair of _hash_.
+  def first
+    at(:first)
+  end
+
+  # call-seq:
+  #   hash.last => aHash
+  #
+  # Returns the "last" key/value pair of _hash_.
+  def last
+    at(:last)
+  end
+
+  # call-seq:
+  #   hash.rand => aHash
+  #
+  # Returns a random key/value pair of _hash_.
+  def rand
+    at(:rand)
+  end
+
+end