kitchensink 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-03-01
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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 OR COPYRIGHT HOLDERS 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/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/kitchensink.rb
+lib/kitchensink/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_kitchensink.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,8 @@
+= Kitchen Sink
+
+Kitchen Sink is a collection of hopefully-useful methods and tweaks, little things that I think should be in Ruby Standard Library but currently aren't.
+
+My experience has been that just about every Ruby programmer I have worked with has independently created some of these tweaks. As a result, I can claim no great personal originality in this gem other than finally collecting them all together.
+
+Because it is likely that you or some of the libraries you are using already have one or more of these tweaks, every tweak in Kitchen Sink first checks to see if the tweak has already been defined, and politely refuses to overwrite your existing tweaks.
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'kitchensink/version'
+
+AUTHOR = 'FIXME full name'  # can also be an array of Authors
+EMAIL = "FIXME email"
+DESCRIPTION = "description of gem"
+GEM_NAME = 'kitchensink' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'kitchensink' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Kitchensink::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'kitchensink documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'kitchensink'

data/lib/kitchensink.rb

@@ -0,0 +1,200 @@
+$:.unshift File.dirname(__FILE__)
+
+unless Enumerable.method_defined? :rest
+  module Enumerable
+    # Returns all elements after the first.
+    def rest
+      self[1..-1]
+    end
+  end
+end
+
+unless Enumerable.method_defined? :rrest
+  module Enumerable
+    # Returns a new collection containing all elements except for the last
+    #--
+    # This has a very PHPesque name and needs a better one. (PHP has an idiom
+    # where array methods that work in one direction can be reversed by
+    # prepending r to them. See sort=>rsort, ksort=>krsort, and asort=>arsort.
+    # Problem is, what's a good word meaning "everything but the last"? I
+    # briefly toyed with "lizard" since it's the Enumeration "with the tail
+    # cut off" but that's not very intuitive to somebody looking at the method
+    # for the first time. I need a word that suggests to the reader what it
+    # means, and that with a little context the reader could determine the
+    # meaning correctly almost all every time.
+    def rrest
+      self[0..-2]
+    end
+  end
+end
+
+unless Array.method_defined? :sum
+  class Array
+    # Adds all elements of an array together:
+    # * [1,2,3].sum => 6
+    # * [1.0, 2.0, 3.0].sum => 6.0
+    # * %w{a b c}.sum => "abc"
+    # * [Vector[1,0,0], Vector[0,2,0], Vector[0,0,3]].sum => Vector[1,2,3]
+    def sum
+      inject {|sum,element| sum+element}
+    end
+  end
+end
+
+unless Array.method_defined? :product
+  class Array
+    # Multiplies all elements of an array together:
+    # * [2,3,4].product => 24
+    # * [2.0, 3.0, 4.0].product => 24.0
+    # * ["NO", 3, 2].product => "NONONONONONO"
+    def product
+      inject {|product,element| product*element}
+    end
+  end
+end
+
+unless Array.method_defined? :hash_by
+  class Array
+    # Construct a hash of objects, keyed by some object attribute.
+    # 
+    # Original idea and code by Brian Dainton. Taken from his blog, The Budding Rubyist.
+    # http://buddingrubyist.wordpress.com/2008/02/05/why-i-like-to-inject/
+    def hash_by(attribute)
+      inject({}) do |results, obj|
+        results[obj.send(attribute)] = obj
+        results
+      end
+    end
+  end
+end
+
+ 
+unless Object.respond_to? :class_method
+  class Object
+    # Returns an +UnboundMethod+ representing a given class method in a class.
+    # 
+    # See Also: instance_method
+    #
+    # Examples:
+    #   sc = String.class_method(:superclass)
+    #   sc.bind(String).call()
+    #   => Object
+    #--
+    # Note that here we use the "class << self; self; end.send" trick, which
+    # gives us access to the singleton class rather than the class itself.
+    # Setting instance methods here causes the subclass to receive class
+    # methods. Yay!
+    def self.class_method(name)
+      class << self; self; end.send :instance_method, name
+    end
+  end
+end
+
+unless Object.respond_to? :remove_class_method
+  class Object
+    # Removes a class method.
+    def self.remove_class_method(name)
+      class << self; self; end.send :remove_method, name
+    end
+  end
+end
+
+unless Object.respond_to? :define_class_method
+  class Object
+    # Works like define_method, only creates a class method.
+    # * <tt>define_class_method(symbol, method)</tt> => new_method
+    # * <tt>define_class_method(symbol) {block}</tt> => proc
+    #
+    # Examples:
+    #   String.define_class_method :get_parent_class, String.class_method(:superclass)
+    #   String.define_class_method :make_runon do |str, num|
+    #     String.new(str) * num
+    #   end
+    #   String.make_runon "abc", 3
+    #   => "abcabcabc"
+    def self.define_class_method(name, method=nil, &block)
+      if method
+        class << self; self; end.send :define_method, name, method
+      else
+        class << self; self; end.send :define_method, name, &block
+      end
+    end
+  end
+end
+
+unless Object.method_defined? :included_in?
+  class Object
+    # True if a collection includes this object.
+    #    
+    # Note: I wrote this because
+    # sometimes <tt>collection.include?(object)</tt> violates left-to-right reading
+    # order, such as when +object+ is more important than the +collection+.
+    def included_in?(collection)
+      collection.include? self
+    end
+  end
+end
+
+unless Symbol.method_defined? :to_proc
+  class Symbol
+    # Convert a Symbol to proc.
+    # 
+    # This is already in Ruby CVS, and should appear in Ruby 1.9
+    def to_proc
+      Proc.new { |obj, *args| obj.send(self, *args) }
+    end
+  end
+end
+
+unless Hash.method_defined? :except
+  class Hash
+    # Filter keys out of a Hash.
+    #
+    #  >> {:a=>1, :b=>2, :c=>3}.except(:a)
+    #  => {:b=>2, :c=>3}
+    #
+    # Source:
+    # * http://wincent.com/knowledge-base/Fixtures_considered_harmful%3F
+    # * Neil Rahilly
+    # * Peepcode episode 11. Geoffrey Grosenbach alludes to this being a
+    #   common idiom among rSpec coders.
+    def except(*keys)
+      self.reject { |k,v| keys.include?(k || k.to_sym) }
+    end
+  end
+end
+
+unless Hash.method_defined? :only
+  class Hash
+    # Returns a hash with only the pairs identified by +keys+
+    #
+    # Source:
+    # * http://wincent.com/knowledge-base/Fixtures_considered_harmful%3F
+    # * Neil Rahilly
+    # * Peepcode episode 11. Geoffrey Grosenbach alludes to this being a
+    #   common idiom among rSpec coders.
+    def only(*keys)
+      self.reject { |k,v| !keys.include?(k || k.to_sym) }
+    end
+  end
+end
+
+unless Hash.method_defined? :with
+  class Hash
+    # Merge keys into a Hash.
+    #
+    #  >> {:a=>1, :b=>2, :c=>3}.with({:a=>4,:b=>5})
+    #  => {:a=>4, :b=>5, :c=>3}
+    #
+    # Source:
+    # * http://wincent.com/knowledge-base/Fixtures_considered_harmful%3F
+    # * Neil Rahilly
+    # * Peepcode episode 11. Geoffrey Grosenbach alludes to this being a
+    #   common idiom among rSpec coders.
+    #
+    # Known Issue: This method conflicts with utility_belt's with statement.
+    def with(overrides = {})
+      self.merge overrides
+    end
+  end
+end

data/lib/kitchensink/version.rb

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

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/kitchensink/version.rb'
+
+version  = Kitchensink::VERSION::STRING
+download = 'http://rubyforge.org/projects/kitchensink'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)