nuggets 0.9.9 → 1.0.0

data/lib/nuggets/object/boolean.rb

@@ -0,0 +1,5 @@
+require 'nuggets/object/boolean_mixin'
+
+class Object
+  include Nuggets::Object::BooleanMixin
+end

data/lib/nuggets/object/boolean_mixin.rb

@@ -0,0 +1,61 @@
+#--
+###############################################################################
+#                                                                             #
+# 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 Object
+    module BooleanMixin
+
+  # call-seq:
+  #   object.boolean? => +true+ or +false+
+  #
+  #
+  def boolean?
+    is_a?(::TrueClass) || is_a?(::FalseClass)
+  end
+
+  # call-seq:
+  #   object.negate => +true+ or +false+
+  #
+  #
+  def negate
+    !self
+  end
+
+  alias_method :false?, :negate
+
+  # call-seq:
+  #   object.to_bool => +true+ or +false+
+  #
+  #
+  def to_bool
+    !!self
+  end
+
+  alias_method :true?, :to_bool
+
+    end
+  end
+end

data/lib/nuggets/object/eigenclass.rb

@@ -0,0 +1,2 @@
+# whatever you prefer to call it...
+require 'nuggets/object/singleton_class'

data/lib/nuggets/object/ghost_class.rb

@@ -0,0 +1,2 @@
+# whatever you prefer to call it...
+require 'nuggets/object/singleton_class'

data/lib/nuggets/object/metaclass.rb

@@ -0,0 +1,2 @@
+# whatever you prefer to call it...
+require 'nuggets/object/singleton_class'

data/lib/nuggets/object/msend.rb

@@ -0,0 +1,5 @@
+require 'nuggets/object/msend_mixin'
+
+class Object
+  include Nuggets::Object::MSendMixin
+end

data/lib/nuggets/object/msend_mixin.rb

@@ -0,0 +1,43 @@
+#--
+###############################################################################
+#                                                                             #
+# 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 Object
+    module MSendMixin
+
+  # call-seq:
+  #   object.msend(*messages) => anArray
+  #
+  # Sends _object_ multiple +messages+ and returns an array of the individual
+  # return values.
+  def msend(*messages)
+    hash = messages.last.is_a?(::Hash) ? messages.pop : {}
+    (messages + hash.to_a).map { |msg| send(*msg.is_a?(::Array) ? msg : [msg]) }
+  end
+
+    end
+  end
+end

data/lib/nuggets/object/silence.rb

@@ -0,0 +1,5 @@
+require 'nuggets/object/silence_mixin'
+
+class Object
+  include Nuggets::Object::SilenceMixin
+end

data/lib/nuggets/object/silence_mixin.rb

@@ -0,0 +1,44 @@
+#--
+###############################################################################
+#                                                                             #
+# 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 Object
+    module SilenceMixin
+
+  # call-seq:
+  #   silence { ... }
+  #
+  # Silence warnings for block execution.
+  def silence
+    verbose, $VERBOSE = $VERBOSE, nil
+    yield
+  ensure
+    $VERBOSE = verbose
+  end
+
+    end
+  end
+end

data/lib/nuggets/object/singleton_class.rb

@@ -0,0 +1,5 @@
+require 'nuggets/object/singleton_class_mixin'
+
+class Object
+  include Nuggets::Object::SingletonClassMixin
+end

data/lib/nuggets/object/singleton_class_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/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+module Nuggets
+  class Object
+    module SingletonClassMixin
+
+  # call-seq:
+  #   object.singleton_class => aClass
+  #
+  # Returns the singleton (or virtual/eigen/meta) class associated with _object_.
+  def singleton_class
+    class << self; self; end
+  end
+
+  alias_method :virtual_class, :singleton_class
+  alias_method :ghost_class,   :singleton_class
+  alias_method :eigenclass,    :singleton_class
+  alias_method :metaclass,     :singleton_class
+  alias_method :uniclass,      :singleton_class
+
+  # call-seq:
+  #   object.singleton_object => anObject
+  #
+  # Returns the object of which _object_ is the singleton_class.
+  # Raises a TypeError if _object_ is not a singleton class.
+  def singleton_object
+    [true, false, nil].each { |obj|
+      return obj if self.equal?(obj.singleton_class)
+    }
+
+    # raises TypeError if neither class nor module
+    ::ObjectSpace.each_object(self) { |obj|
+      return obj if self.equal?(obj.singleton_class)
+    }
+
+    # if we got here, it can't be a singleton class
+    # or its singleton object doesn't exist anymore
+    raise ::TypeError
+  rescue ::TypeError
+    raise ::TypeError, 'not a singleton class'
+  end
+
+  alias_method :virtual_object, :singleton_object
+  alias_method :ghost_object,   :singleton_object
+  alias_method :eigenobject,    :singleton_object
+  alias_method :metaobject,     :singleton_object
+  alias_method :uniobject,      :singleton_object
+
+  alias_method :singleton_instance, :singleton_object
+
+  # call-seq:
+  #   object.singleton_class? => +true+ or +false+
+  #
+  # Returns +true+ if _object_ is a singleton_class
+  # (i.e., has a singleton_object), +false+ otherwise.
+  def singleton_class?
+    singleton_object
+    true
+  rescue ::TypeError
+    false
+  end
+
+  alias_method :virtual_class?, :singleton_class?
+  alias_method :ghost_class?,   :singleton_class?
+  alias_method :eigenclass?,    :singleton_class?
+  alias_method :metaclass?,     :singleton_class?
+  alias_method :uniclass?,      :singleton_class?
+
+    end
+  end
+end

data/lib/nuggets/object/uniclass.rb

@@ -0,0 +1,2 @@
+# whatever you prefer to call it...
+require 'nuggets/object/singleton_class'

data/lib/nuggets/object/virtual_class.rb

@@ -0,0 +1,2 @@
+# whatever you prefer to call it...
+require 'nuggets/object/singleton_class'

data/lib/nuggets/pluggable.rb

@@ -0,0 +1,91 @@
+#--
+###############################################################################
+#                                                                             #
+# 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 'set'
+
+module Nuggets
+  module Pluggable
+
+    def self.load_plugins_for(*klasses)
+      klasses.map { |klass| klass.extend(self).load_plugins }
+    end
+
+    def load_plugins(name = plugin_filename)
+      load_path_plugins(name)
+      load_gem_plugins(name)
+      load_env_plugins(name)
+
+      loaded_plugins.to_a
+    end
+
+    def loaded_plugins
+      @loaded_plugins ||= Set.new
+    end
+
+    def plugin_filename
+      @plugin_filename ||= "#{name.
+        gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+        gsub(/([a-z\d])([A-Z])/,     '\1_\2').
+        gsub(/::/, '/').tr('-', '_').downcase}_plugin.rb"
+    end
+
+    attr_writer :plugin_filename
+
+    private
+
+    def load_path_plugins(name)
+      $LOAD_PATH.dup.each { |path|
+        plugin = ::File.expand_path(name, path)
+        load_plugin_file(plugin) if ::File.file?(plugin)
+      }
+    end
+
+    def load_gem_plugins(name)
+      ::Gem::Specification.latest_specs.each { |spec|
+        load_plugin_files(spec.matches_for_glob(name))
+      } if ::Object.const_defined?(:Gem)
+    end
+
+    def load_env_plugins(name)
+      path = ::ENV["#{name.chomp(ext = ::File.extname(name)).upcase}_PATH"]
+      path.split(::File::PATH_SEPARATOR).each { |dir|
+        load_plugin_files(::Dir["#{dir}/*#{ext}"])
+      } if path
+    end
+
+    def load_plugin_file(plugin)
+      load plugin if loaded_plugins.add?(plugin)
+    rescue ::Exception => err
+      raise unless loaded_plugins.delete?(plugin)
+      warn "Error loading #{name} plugin: #{plugin}: #{err} (#{err.class})"
+    end
+
+    def load_plugin_files(plugins)
+      plugins.each { |plugin| load_plugin_file(::File.expand_path(plugin)) }
+    end
+
+  end
+end

data/lib/nuggets/proc/bind.rb

@@ -0,0 +1,5 @@
+require 'nuggets/proc/bind_mixin'
+
+class Proc
+  include Nuggets::Proc::BindMixin
+end

data/lib/nuggets/proc/bind_mixin.rb

@@ -0,0 +1,51 @@
+#--
+###############################################################################
+#                                                                             #
+# 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 Proc
+    module BindMixin
+
+  # call-seq:
+  #   proc.bind(object) => aMethod
+  #
+  # Straight from Rails' ActiveSupport -- effectively binds _proc_ to +object+.
+  def bind(object)
+    block, time = self, ::Time.now
+
+    (class << object; self; end).class_eval {
+      method_name = "__bind_#{time.to_i}_#{time.usec}"
+      define_method(method_name, &block)
+
+      method = instance_method(method_name)
+      remove_method(method_name)
+
+      method
+    }.bind(object)
+  end
+
+    end
+  end
+end