nuggets 0.9.9 → 1.0.0

data/lib/nuggets/string/word_wrap.rb

@@ -0,0 +1,76 @@
+#--
+###############################################################################
+#                                                                             #
+# 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 'enumerator'
+
+class String
+
+  # call-seq:
+  #   str.word_wrap(line_width) => new_str
+  #
+  # Word wrap a string not exceeding +line_width+. Based on the Ruby Facets
+  # implementation, but preserves paragraphs. Thus
+  # <tt>str == str.word_wrap(str.split("\n").map { |l| l.length }.max)</tt>.
+  def word_wrap(line_width = 80, as_array = false)
+    wrapped = []
+
+    split(/(\n+)/).to_enum(:each_slice, 2).each { |paragraph, linebreaks|
+      wrapped << paragraph.word_wrap_paragraph!(line_width) << linebreaks
+    }
+
+    wrapped = wrapped.join
+
+    as_array ? wrapped.split("\n") : wrapped
+  end
+
+  # call-seq:
+  #   str.word_wrap!(line_width) => str
+  #
+  # As with #word_wrap, but modifies the string in place.
+  def word_wrap!(line_width = 80)
+    replace(word_wrap(line_width))
+  end
+
+  # call-seq:
+  #   str.word_wrap_paragraph(line_width) => new_str
+  #
+  # Similar to #word_wrap, but assumes a single paragraph.
+  def word_wrap_paragraph(line_width = 80)
+    (_dup = dup).word_wrap_paragraph!(line_width) || _dup
+  end
+
+  # call-seq:
+  #   str.word_wrap_paragraph!(line_width) => str
+  #
+  # Destructive version of #word_wrap_paragraph.
+  def word_wrap_paragraph!(line_width = 80)
+    gsub!(/(.{1,#{line_width}})(?:\s+|$)/, "\\1\n")
+    sub!(/\n$/, '')
+
+    self
+  end
+
+end

data/lib/nuggets/string/xor.rb

@@ -0,0 +1,5 @@
+require 'nuggets/string/xor_mixin'
+
+class String
+  include Nuggets::String::XorMixin
+end

data/lib/nuggets/string/xor_mixin.rb

@@ -0,0 +1,59 @@
+#--
+###############################################################################
+#                                                                             #
+# 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/integer/to_binary_s'
+
+module Nuggets
+  class String
+    module XorMixin
+
+  # call-seq:
+  #   str ^ other => new_string
+  #   str.xor(other) => new_string
+  #
+  # Bitwise EXCLUSIVE OR.
+  def xor(other, require_same_length = false)
+    format = 'B*'
+    binary = [self, other.to_s].map { |s| s.unpack(format).first }
+
+    length = binary.map { |s| s.length }.inject { |a, b|
+      if require_same_length
+        a == b ? a : raise(::ArgumentError, 'must be of same length')
+      else
+        [a, b].max
+      end
+    }
+
+    [binary.map { |s| s.to_i(2) }.
+            inject { |a, b| a ^ b }.
+            to_binary_s(length)].pack(format)
+  end
+
+  alias_method :^, :xor
+
+    end
+  end
+end

data/lib/nuggets/tempfile/open.rb

@@ -0,0 +1,57 @@
+#--
+###############################################################################
+#                                                                             #
+# 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 'tempfile'
+
+class Tempfile
+
+  class << self
+
+    alias_method :_nuggets_original_open, :open
+
+    # If no block is given, this is a synonym for new().
+    #
+    # If a block is given, it will be passed tempfile as an argument,
+    # and the tempfile will automatically be closed when the block
+    # terminates.  In this case, open() returns tempfile -- in contrast
+    # to the original implementation, which returns +nil+.
+    def open(*args)
+      tempfile = new(*args)
+
+      if block_given?
+        begin
+          yield tempfile
+        ensure
+          tempfile.close
+        end
+      end
+
+      tempfile
+    end
+
+  end
+
+end

data/lib/nuggets/uri/content_type.rb

@@ -0,0 +1,5 @@
+require 'nuggets/uri/content_type_mixin'
+
+module URI
+  extend Nuggets::URI::ContentTypeMixin
+end

data/lib/nuggets/uri/content_type_mixin.rb

@@ -0,0 +1,47 @@
+#--
+###############################################################################
+#                                                                             #
+# 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/uri/exist_mixin'
+
+module Nuggets
+  module URI
+    module ContentTypeMixin
+
+  def self.extended(base)
+    base.extend Nuggets::URI::ExistMixin
+  end
+
+  # call-seq:
+  #   URI.content_type(uri) => aString or +nil+
+  #
+  # Return the content type of +uri+, or +nil+ if not found.
+  def content_type(uri)
+    exist?(uri) { |res| res.content_type }
+  end
+
+    end
+  end
+end

data/lib/nuggets/uri/exist.rb

@@ -0,0 +1,5 @@
+require 'nuggets/uri/exist_mixin'
+
+module URI
+  extend Nuggets::URI::ExistMixin
+end

data/lib/nuggets/uri/exist_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/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+require 'nuggets/uri/redirect_mixin'
+require 'nuggets/net/success'
+
+module Nuggets
+  module URI
+    module ExistMixin
+
+  def self.extended(base)
+    base.extend Nuggets::URI::RedirectMixin
+  end
+
+  # call-seq:
+  #   URI.exist?(uri) => +true+, +false+ or +nil+
+  #   URI.exist?(uri) { |res| ... } => anObject, +false+ or +nil+
+  #
+  # Checks whether the URI +uri+ exists by performing a +HEAD+ request. If
+  # successful, yields the response to the given block and returns its return
+  # value, or +true+ if no block was given. Returns +false+ in case of failure,
+  # or +nil+ if the redirect limit has been exceeded.
+  #
+  # See Nuggets::URI::RedirectMixin#follow_redirect for more information.
+  def exist?(uri)
+    head_redirect(uri) { |res| res.success? && (!block_given? || yield(res)) }
+  end
+
+  alias_method :exists?, :exist?
+
+    end
+  end
+end

data/lib/nuggets/uri/redirect.rb

@@ -0,0 +1,5 @@
+require 'nuggets/uri/redirect_mixin'
+
+module URI
+  extend Nuggets::URI::RedirectMixin
+end

data/lib/nuggets/uri/redirect_mixin.rb

@@ -0,0 +1,101 @@
+#--
+###############################################################################
+#                                                                             #
+# 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 'net/https'
+
+module Nuggets
+  module URI
+    module RedirectMixin
+
+  # Maximum number of redirects to follow.
+  URI_REDIRECT_MAX_STEPS = 20
+
+  # Cache for HTTP objects to reuse.
+  URI_REDIRECT_HTTP_CACHE = ::Hash.new { |h, k| h[k] = ::Net::HTTP.new(*k) }
+
+  # call-seq:
+  #   URI.follow_redirect(uri[, steps]) { |req, path| ... } => aResponse or +nil+
+  #
+  # Performs any HTTP request on +uri+ while following at most +steps+ redirects.
+  # Accepts both strings and URI objects for +uri+. Defers to the given block to
+  # perform the actual request; yields the request object and the request URI
+  # string.
+  #
+  # Returns the response object if successful, or +nil+ if +uri+ is not an HTTP
+  # URI, the redirect limit has been exceeded, or any connection error occurs.
+  def follow_redirect(uri, steps = URI_REDIRECT_MAX_STEPS, cache = URI_REDIRECT_HTTP_CACHE)
+    unless uri.is_a?(::URI::HTTP)
+      uri = ::URI.parse(uri.to_s)
+      return unless uri.is_a?(::URI::HTTP)
+    end
+
+    req = cache[[uri.host, uri.port]]
+    req.use_ssl = uri.is_a?(::URI::HTTPS)
+
+    ctx = req.instance_variable_get(:@ssl_context) if req.use_ssl?
+    ctx.verify_mode ||= ::OpenSSL::SSL::VERIFY_NONE if ctx
+
+    res = yield req, uri.request_uri
+    return res unless res.is_a?(::Net::HTTPRedirection)
+    return nil unless steps > 0
+
+    follow_redirect(res['Location'], steps - 1, cache) { |*a| yield(*a) }
+  rescue ::SocketError, ::Errno::EHOSTUNREACH, ::Errno::ENOENT
+  end
+
+  # call-seq:
+  #   URI.head_redirect(uri[, steps]) => aResponse or +nil+
+  #   URI.head_redirect(uri[, steps]) { |res| ... } => anObject or +nil+
+  #
+  # Performs a +HEAD+ request on +uri+ while following at most +steps+ redirects.
+  # If successful, yields the response to the given block and returns its return
+  # value, or the response itself if no block was given. Returns +nil+ in case
+  # of failure.
+  #
+  # See Nuggets::URI::RedirectMixin#follow_redirect for more information.
+  def head_redirect(uri, steps = URI_REDIRECT_MAX_STEPS)
+    res = follow_redirect(uri, steps) { |req, path| req.head(path) }
+    res && block_given? ? yield(res) : res
+  end
+
+  # call-seq:
+  #   URI.get_redirect(uri[, steps]) => aResponse or +nil+
+  #   URI.get_redirect(uri[, steps]) { |res| ... } => anObject or +nil+
+  #
+  # Performs a +GET+ request on +uri+ while following at most +steps+ redirects.
+  # If successful, yields the response to the given block and returns its return
+  # value, or the response itself if no block was given. Returns +nil+ in case
+  # of failure.
+  #
+  # See Nuggets::URI::RedirectMixin#follow_redirect for more information.
+  def get_redirect(uri, steps = URI_REDIRECT_MAX_STEPS)
+    res = follow_redirect(uri, steps) { |req, path| req.get(path) }
+    res && block_given? ? yield(res) : res
+  end
+
+    end
+  end
+end

data/lib/nuggets/version.rb

@@ -0,0 +1,27 @@
+module Nuggets
+
+  module Version
+
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    class << self
+
+      # Returns array representation.
+      def to_a
+        [MAJOR, MINOR, TINY]
+      end
+
+      # Short-cut for version string.
+      def to_s
+        to_a.join('.')
+      end
+
+    end
+
+  end
+
+  VERSION = Version.to_s
+
+end