nuggets 0.9.9 → 1.0.0

data/ChangeLog

@@ -0,0 +1,7 @@
+# markup: rd
+
+= Revision history for nuggets
+
+== 1.0.0 [2014-06-20]
+
+* First release under new name. Formerly known as ruby-nuggets.

data/README

@@ -0,0 +1,74 @@
+= nuggets - Extending Ruby
+
+== VERSION
+
+This documentation refers to nuggets version 1.0.0.
+
+
+== DESCRIPTION
+
+Nuggets provides a collection of extensions to Ruby classes.
+It's similar to projects like Facets[http://rubyworks.github.com/facets]
+and Extensions[http://extensions.rubyforge.org] (or even
+Labrador[http://labrador.rubyforge.org]).
+
+This is simply where I put stuff that I need on a more or
+less regular basis or that struck me as interesting while
+surfing the web, reading books, or following discussions on
+ruby-talk[http://lists.ruby-lang.org/cgi-bin/mailman/listinfo/ruby-talk].
+
+There are several ways to get the extensions you're interested in:
+
+  # Either require() what you need:
+  require 'nuggets/object/singleton_class'
+  require 'nuggets/string/sub_with_md'
+  require 'nuggets/string/nsub'
+
+  # Or use the helper method (see the documentation of Nuggets()
+  # for more examples):
+  require 'nuggets'
+  Nuggets(object: 'singleton_class', string: %w[sub_with_md nsub])
+
+
+== NEW NAME
+
+This project used to be named <tt>ruby-nuggets</tt> but was renamed
+to +nuggets+ with version 1.0.0. Please update your dependencies.
+(Require paths are unchanged.)
+
+
+== DISCLAIMER
+
+Please be aware that some of the things herein might not work as
+expected or cause other libraries to misbehave. Use at your own risk!
+
+
+== LINKS
+
+Documentation:: https://blackwinter.github.io/nuggets/
+Source code::   https://github.com/blackwinter/nuggets
+RubyGem::       https://rubygems.org/gems/nuggets
+Travis CI::     https://travis-ci.org/blackwinter/nuggets
+
+
+== AUTHORS
+
+* Jens Wille <mailto:jens.wille@gmail.com>
+
+
+== LICENSE AND COPYRIGHT
+
+Copyright (C) 2007-2014 Jens Wille
+
+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/>.

data/Rakefile

@@ -0,0 +1,50 @@
+require File.expand_path(%q{../lib/nuggets/version}, __FILE__)
+
+begin
+  require 'hen'
+
+  Hen.lay! {{
+    gem: {
+      name:         %q{nuggets},
+      version:      Nuggets::VERSION,
+      summary:      %q{Extending Ruby.},
+      description:  %q{Various extensions to Ruby classes.},
+      author:       %q{Jens Wille},
+      email:        %q{jens.wille@gmail.com},
+      license:      %q{AGPL-3.0},
+      homepage:     :blackwinter,
+      dependencies: %w[],
+
+      development_dependencies: [
+       #'amatch',         # enumerable/agrep
+        'mime-types',     # content_type
+        'open4',          # ruby
+       #'ruby-filemagic'  # content_type
+      ],
+
+      required_ruby_version: '>= 1.9.3'
+    }
+  }}
+rescue LoadError => err
+  warn "Please install the `hen' gem. (#{err})"
+end
+
+desc 'Run all specs in isolation'
+task 'spec:isolated' do
+  ARGV.delete('spec:isolated')
+  ARGV.unshift('spec')
+
+  Dir['spec/*/**/*_spec.rb'].each { |spec|
+    ENV['SPEC'] = spec
+    system($0, *ARGV)
+  }
+end
+
+if RUBY_PLATFORM == 'java'
+  task spec: :enable_objspace
+
+  task :enable_objspace do
+    k, v = 'JRUBY_OPTS', '-X+O'
+    ENV[k] ? ENV[k] += " #{v}" : ENV[k] = v
+  end
+end

data/lib/nuggets.rb

@@ -0,0 +1,73 @@
+#--
+###############################################################################
+#                                                                             #
+# nuggets -- Extending Ruby                                                   #
+#                                                                             #
+# Copyright (C) 2007-2014 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/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+# Load selected +nuggets+.
+#
+# Examples:
+#   # All String nuggets
+#   Nuggets(:string)
+#   Nuggets(String)
+#
+#   # Only 'msub' and 'word_wrap' String nuggets
+#   Nuggets(string: %w[msub word_wrap])
+#
+#   # Selected String nuggets and all Numeric nuggets
+#   Nuggets(:numeric, string: %w[msub word_wrap])
+#
+#   # etc.
+def Nuggets(*nuggets)
+  loaded_nuggets, load_nuggets = [], lambda { |base, *nuggets|
+    nuggets_by_hierarchy = nuggets.last.is_a?(Hash) ? nuggets.pop : {}
+
+    nuggets.each { |nugget|
+      begin
+        require path = File.join(base.to_s, nugget.to_s.downcase)
+        loaded_nuggets << path
+      rescue LoadError
+        # if it's a directory, load anything in it
+        $LOAD_PATH.each { |dir|
+          if File.directory?(dir_path = File.join(dir, path))
+            load_nuggets[path, *Dir[File.join(dir_path, '*')].map { |file|
+              File.basename(file, '.rb') unless file.end_with?('_mixin.rb')
+            }.compact]
+            break
+          end
+        } and raise  # otherwise, re-raise
+      end
+    }
+
+    nuggets_by_hierarchy.each { |hierarchy, nuggets|
+      nuggets = [nuggets] if nuggets.is_a?(Hash)
+      load_nuggets[File.join(base.to_s, hierarchy.to_s.downcase), *nuggets]
+    }
+  }
+
+  load_nuggets['nuggets', *nuggets]
+
+  loaded_nuggets
+end
+
+require_relative 'nuggets/version'

data/lib/nuggets/all.rb

@@ -0,0 +1,35 @@
+#--
+###############################################################################
+#                                                                             #
+# 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/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+base = ::File.dirname(__FILE__)
+base_re = ::Regexp.escape(base)
+
+::Dir[::File.join(base, %w[* ** *.rb])].sort.each { |path|
+  next if path.include?('/util/') || path.end_with?('_mixin.rb')
+
+  ext_re = ::Regexp.escape(::File.extname(path))
+  require path.sub(/#{base_re}(.*)#{ext_re}/, 'nuggets\1')
+}

data/lib/nuggets/all_mixins.rb

@@ -0,0 +1,33 @@
+#--
+###############################################################################
+#                                                                             #
+# 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/>.             #
+#                                                                             #
+###############################################################################
+#++
+
+base = ::File.dirname(__FILE__)
+base_re = ::Regexp.escape(base)
+
+::Dir[::File.join(base, %w[* ** *_mixin.rb])].sort.each { |path|
+  ext_re = ::Regexp.escape(::File.extname(path))
+  require path.sub(/#{base_re}(.*)#{ext_re}/, 'nuggets\1')
+}

data/lib/nuggets/ansicolor2css.rb

@@ -0,0 +1,124 @@
+#--
+###############################################################################
+#                                                                             #
+# 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 ANSIColor2CSS
+
+    extend self
+
+    ATTRIBUTES = {
+        '0' => nil,                              # clear
+        '1' => 'font-weight: bold',              # bold
+        '2' => '',                               # dark
+        '3' => 'font-style: italic',             # italic -- not widely implemented
+        '4' => 'text-decoration: underline',     # underline
+        '5' => 'text-decoration: blink',         # blink
+        '6' => 'text-decoration: blink',         # rapid blink -- not widely implemented
+        '7' => '',                               # reverse
+        '8' => 'opacity: 0',                     # concealed
+        '9' => 'text-decoration: line-through',  # strikethrough -- not widely implemented
+       '22' => 'font-weight: normal',            # bold off
+       '23' => 'font-style: normal',             # italic off
+       '24' => 'text-decoration: none',          # underline off
+       '25' => 'text-decoration: none',          # blink off
+       '27' => '',                               # reverse off
+       '28' => 'opacity: 1',                     # concealed off
+       '29' => 'text-decoration: none',          # strikethrough off
+       '30' => 'color: black',                   # black
+       '31' => 'color: maroon',                  # red
+       '32' => 'color: green',                   # green
+       '33' => 'color: olive',                   # yellow
+       '34' => 'color: navy',                    # blue
+       '35' => 'color: purple',                  # magenta
+       '36' => 'color: teal',                    # cyan
+       '37' => 'color: silver',                  # white
+       '39' => 'color: silver',                  # default (white)
+       '40' => 'background-color: black',        # on black
+       '41' => 'background-color: maroon',       # on red
+       '42' => 'background-color: green',        # on green
+       '43' => 'background-color: olive',        # on yellow
+       '44' => 'background-color: navy',         # on blue
+       '45' => 'background-color: purple',       # on magenta
+       '46' => 'background-color: teal',         # on cyan
+       '47' => 'background-color: silver',       # on white
+       '49' => 'background-color: black',        # on default (black)
+       '90' => 'color: gray',                    # bright black
+       '91' => 'color: red',                     # bright red
+       '92' => 'color: lime',                    # bright green
+       '93' => 'color: yellow',                  # bright yellow
+       '94' => 'color: blue',                    # bright blue
+       '95' => 'color: fuchsia',                 # bright magenta
+       '96' => 'color: cyan',                    # bright cyan
+       '97' => 'color: white',                   # bright white
+      '100' => 'background-color: gray',         # on bright black
+      '101' => 'background-color: red',          # on bright red
+      '102' => 'background-color: lime',         # on bright green
+      '103' => 'background-color: yellow',       # on bright yellow
+      '104' => 'background-color: blue',         # on bright blue
+      '105' => 'background-color: fuchsia',      # on bright magenta
+      '106' => 'background-color: cyan',         # on bright cyan
+      '107' => 'background-color: white'         # on bright white
+    }
+
+    ATTRIBUTES_RE = ::Regexp.union(*ATTRIBUTES.keys)
+
+    DELIMITER = ';'
+
+    COLOR_RE = %r{
+      \e \[ ( #{ATTRIBUTES_RE} (?: #{DELIMITER} #{ATTRIBUTES_RE} )* ) m
+    }x
+
+    STYLE = '<span style="%s">'
+    CLEAR = '</span>'
+
+    def convert(string)
+      string.gsub(COLOR_RE) { format($1.split(DELIMITER).uniq) }
+    end
+
+    def format(attributes)
+      "#{clear(attributes)}#{style(attributes) if attributes.any?}"
+    end
+
+    def clear(attributes)
+      CLEAR if attributes.delete('0')
+    end
+
+    def style(attributes)
+      STYLE % ATTRIBUTES.values_at(*attributes).join('; ')
+    end
+
+  end
+end
+
+class String
+
+  def ansicolor2css
+    ::Nuggets::ANSIColor2CSS.convert(self)
+  end
+
+  alias_method :ansicolour2css, :ansicolor2css
+
+end

data/lib/nuggets/argv/option.rb

@@ -0,0 +1,3 @@
+require 'nuggets/argv/option_mixin'
+
+ARGV.extend(Nuggets::Argv::OptionMixin)

data/lib/nuggets/argv/option_mixin.rb

@@ -0,0 +1,84 @@
+#--
+###############################################################################
+#                                                                             #
+# nuggets -- Extending Ruby                                                   #
+#                                                                             #
+# Copyright (C) 2007-2013 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 Argv
+    module OptionMixin
+
+  # call-seq:
+  #   ARGV.switch(short[, long]) -> true | false
+  #
+  # Whether ARGV includes the switch +short+ (or +long+).
+  def switch(*args)
+    !!(__key(*args) { |key| include?(key) })
+  end
+
+  # call-seq:
+  #   ARGV.option(short[, long]) -> aString
+  #   ARGV.option(short[, long]) { |value| ... } -> anObject
+  #
+  # Returns the value associated with the option +short+ (or +long+) if present
+  # in ARGV. Yields that value to the block if given and returns its result.
+  def option(*args, &block)
+    __opt(block, *args) { |index| at(index + 1) }
+  end
+
+  # call-seq:
+  #   ARGV.switch!(short[, long]) -> true | false
+  #
+  # Whether ARGV includes the switch +short+ (or +long+). Removes the matching
+  # switch from ARGV.
+  def switch!(*args)
+    !!(__key(*args) { |key| delete(key) })
+  end
+
+  # call-seq:
+  #   ARGV.option!(short[, long]) -> aString
+  #   ARGV.option!(short[, long]) { |value| ... } -> anObject
+  #
+  # Returns the value associated with the option +short+ (or +long+) if present
+  # in ARGV and removes both from ARGV. Yields that value to the block if given
+  # and returns its result.
+  def option!(*args, &block)
+    __opt(block, *args) { |index| delete_at(index); delete_at(index) }
+  end
+
+  private
+
+  def __key(short, long = nil)  # :yield: key
+    long && yield("--#{long}") || yield("-#{short}")
+  end
+
+  def __opt(block, *args)
+    index = __key(*args) { |key| index(key) } or return
+
+    value = yield(index)
+    block ? block[value] : value
+  end
+
+    end
+  end
+end