royw-roys_extensions 0.0.2

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Roy Wright
+
+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/README.rdoc

@@ -0,0 +1,8 @@
+= roys_extensions
+
+Various extensions to the standard ruby library classes that I find useful.
+No particular theme or mission.
+
+== Copyright
+
+Copyright (c) 2009 Roy Wright. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "roys_extensions"
+    gem.summary = %Q{TODO}
+    gem.email = "roy@wright.org"
+    gem.homepage = "http://github.com/royw/roys_extensions"
+    gem.authors = ["Roy Wright"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ["--color"]
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "roys_extensions #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 2
+:major: 0

data/lib/file_extensions.rb

@@ -0,0 +1,22 @@
+require 'module_extensions'
+
+# == Synopsis
+# Various extensions to the File class
+# Note, uses the Module.my_extension method to only add the method if
+# it doesn't already exist.
+class File
+  class << self
+    my_extension("mkdirs") do
+      ##
+      # make directories including any missing in the path
+      #
+      # @param [String] dirspec the path to make sure exists
+      def File.mkdirs(dirspec)
+        unless File.exists?(dirspec)
+          mkdirs(File.dirname(dirspec))
+          Dir.mkdir(dirspec)
+        end
+      end
+    end
+  end
+end

data/lib/kernel_extensions.rb

@@ -0,0 +1,20 @@
+require 'module_extensions'
+
+# == Synopsis
+# Various extensions to the Kernel class
+# Note, uses the Module.my_extension method to only add the method if
+# it doesn't already exist.
+module Kernel
+  my_extension("timer") do
+    # == Synopsis
+    # a simple elapse time for the give block
+    # == Usage
+    # elapse_seconds = timer {...}
+    def timer
+      start_time = Time.now
+      yield
+      Time.now - start_time
+    end
+  end
+end
+

data/lib/module_extensions.rb

@@ -0,0 +1,27 @@
+######################################################################
+# my extensions to Module. (taken from rake, named changed to not clash
+# when rake is used)
+#
+class Module
+  # Check for an existing method in the current class before extending.  If
+  # the method already exists, then a warning is printed and the extension is
+  # not added.  Otherwise the block is yielded and any definitions in the
+  # block will take effect.
+  #
+  # Usage:
+  #
+  #   class String
+  #     rake_extension("xyz") do
+  #       def xyz
+  #         ...
+  #       end
+  #     end
+  #   end
+  #
+  def my_extension(method)
+    unless instance_methods.include?(method.to_s) || instance_methods.include?(method.to_sym)
+      yield
+    end
+  end
+end # module Module
+

data/lib/numeric_extensions.rb

@@ -0,0 +1,22 @@
+require 'module_extensions'
+
+# == Synopsis
+# Various extensions to the Numeric class
+# Note, uses the Module.my_extension method to only add the method if
+# it doesn't already exist.
+class Numeric
+  my_extension("elapsed_time_s") do
+    # == Synopsis
+    # return String formated as "HH:MM:SS"
+    def elapsed_time_s
+      seconds = self
+      hours = minutes = 0
+      hours = seconds.div 3600
+      seconds = seconds - (hours * 3600)
+      minutes = seconds.div 60
+      seconds = seconds - (minutes * 60)
+      sprintf("%.2d:%2.2d:%2.2d", hours, minutes, seconds)
+    end
+  end
+end
+

data/lib/object_extensions.rb

@@ -0,0 +1,29 @@
+require 'module_extensions'
+
+# == Synopsis
+# Various extensions to the Object class
+# Note, uses the Module.my_extension method to only add the method if
+# it doesn't already exist.
+class Object
+  my_extension("blank?") do
+    # == Synopsis
+    # return asserted if object is nil or empty
+    def blank?
+      result = nil?
+      unless result
+        if respond_to? 'empty?'
+          if respond_to? 'strip'
+            result = strip.empty?
+          else
+            if respond_to? 'compact'
+              result = compact.empty?
+            else
+              result = empty?
+            end
+          end
+        end
+      end
+      result
+    end
+  end
+end

data/lib/roys_extensions.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'module_extensions'
+require 'string_extensions'
+require 'object_extensions'
+require 'numeric_extensions'
+require 'kernel_extensions'
+require 'file_extensions'

data/lib/string_extensions.rb

@@ -0,0 +1,51 @@
+require 'cgi'
+require 'iconv'
+require 'module_extensions'
+
+# == Synopsis
+# Various extensions to the String class
+# Note, uses the Module.my_extension method to only add the method if
+# it doesn't already exist.
+class String
+  my_extension("unescape_html") do
+    # == Synopsis
+    # unescape HTML
+    def unescape_html
+      Iconv.conv("UTF-8", 'ISO-8859-1', CGI::unescapeHTML(self))
+    end
+  end
+
+  my_extension("escape_unicode") do
+    # == Synopsis
+    # this handles unicode characters by converting each byte to "%XX"
+    # where XX is the hex value
+    def escape_unicode
+      self.each_byte.collect{|c| c.to_i > 127 ? "%#{c.to_i.to_s(16)}" : c.chr}.join('')
+    end
+  end
+
+  my_extension("strip_tags") do
+    # == Synopsis
+    # remove angle bracket tags from the string
+    def strip_tags
+      gsub(/<\/?[^>]*>/, "")
+    end
+  end
+
+  my_extension("ext") do
+    # == Synopsis
+    # Replace the file extension with +newext+.  If there is no extenson on
+    # the string, append the new extension to the end.  If the new extension
+    # is not given, or is the empty string, remove any existing extension.
+    #
+    # +ext+ is a user added method for the String class.
+    def ext(newext='')
+      return self.dup if ['.', '..'].include? self
+      if newext != ''
+        newext = (newext =~ /^\./) ? newext : ("." + newext)
+      end
+      dup.sub!(%r(([^/\\])\.[^./\\]*$)) { $1 + newext } || self + newext
+    end
+  end
+end
+

data/spec/file_extensions_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'tempfile'
+require 'fileutils'
+include FileUtils
+
+TMPDIR = File.join(File.dirname(__FILE__), '../tmp')
+
+describe "FileExtensions" do
+  before(:all) do
+    Dir.mkdir(TMPDIR) unless File.exist?(TMPDIR)
+  end
+
+  after(:each) do
+    rm_rf(Dir.glob(File.join(TMPDIR,'file_extensions_spec*')))
+  end
+
+  it "should make a single directory when it does not exist" do
+    dirspec = get_temp_filename
+    File.mkdirs(dirspec)
+    (File.exist?(dirspec).should be_true) && (File.directory?(dirspec).should be_true)
+  end
+
+  it "should make a multiple directories when they do not exist" do
+    dirspec = File.join(get_temp_filename, 'foo', 'bar')
+    File.mkdirs(dirspec)
+    (File.exist?(dirspec).should be_true) && (File.directory?(dirspec).should be_true)
+  end
+
+  it "should not make any directories when they already exist" do
+    dirspec = File.join(get_temp_filename, 'foo', 'bar')
+    File.mkdirs(dirspec)
+    File.mkdirs(dirspec)
+    (File.exist?(dirspec).should be_true) && (File.directory?(dirspec).should be_true)
+  end
+
+
+  def get_temp_filename
+    outfile = Tempfile.new('file_extensions_spec', TMPDIR)
+    filespec = outfile.path
+    outfile.unlink
+    filespec
+  end
+
+end

data/spec/kernel_extensions_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe "KernelExtensions" do
+  it "should time a block of code" do
+    elapse = timer { sleep 1.1 }
+    (elapse.should > 1) && (elapse.should < 2)
+  end
+
+end

data/spec/module_extensions_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'ruby-debug'
+
+describe "ModuleExtensions" do
+  it "should allow a method to be added to a class when the method does not already exists" do
+    class A
+      my_extension("foo") do
+        def foo
+          'foo'
+        end
+      end
+    end
+    A.instance_methods.include?('foo').should be_true
+  end
+
+  it "should not allow adding a method to a class if the method already exists" do
+    class A
+      def foo
+        'bar'
+      end
+    end
+
+    class A
+      my_extension("foo") do
+        def foo
+          'foo'
+        end
+      end
+    end
+    a = A.new
+    a.foo.should == 'bar'
+  end
+
+end

data/spec/numeric_extensions_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe "NumericExtensions" do
+  it "should convert 0 seconds to '00:00:00'" do
+    0.elapsed_time_s.should == '00:00:00'
+  end
+
+  it "should convert 59 seconds to '00:00:59'" do
+    59.elapsed_time_s.should == '00:00:59'
+  end
+
+  it "should convert 60 seconds to '00:01:00'" do
+    60.elapsed_time_s.should == '00:01:00'
+  end
+
+  it "should convert 3599 seconds to '00:59:59'" do
+    3599.elapsed_time_s.should == '00:59:59'
+  end
+
+  it "should convert 3600 seconds to '01:00:00'" do
+    3600.elapsed_time_s.should == '01:00:00'
+  end
+
+  it "should convert 86399 seconds to '23:59:59'" do
+    86399.elapsed_time_s.should == '23:59:59'
+  end
+
+  it "should convert 86400 seconds to '24:00:00'" do
+    86400.elapsed_time_s.should == '24:00:00'
+  end
+
+  it "should convert 359999 seconds to '99:59:59'" do
+    359999.elapsed_time_s.should == '99:59:59'
+  end
+
+  it "should convert 360000 seconds to '100:00:00'" do
+    360000.elapsed_time_s.should == '100:00:00'
+  end
+
+
+end

data/spec/object_extensions_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe "ObjectExtensions" do
+  it "should be blank for nil" do
+    nil.blank?.should be_true
+  end
+
+  it "should be blank for empty String" do
+    ''.blank?.should be_true
+  end
+
+  it "should be blank for pure white space String" do
+    ' '.blank?.should be_true
+  end
+
+  it "should be blank for empty Array" do
+    [].blank?.should be_true
+  end
+
+  it "should be blank for Array of nils" do
+    [nil, nil].blank?.should be_true
+  end
+
+  it "should be blank for empty Hash" do
+    {}.blank?.should be_true
+  end
+
+  it "should not be blank for non-empty String" do
+    ' foo '.blank?.should be_false
+  end
+
+  it "should not be blank for non-empty Array" do
+    [1].blank?.should be_false
+  end
+
+  it "should not be blank for empty embedded Arrays" do
+    [[]].blank?.should be_false
+  end
+
+  it "should not be blank for non-empty Hash" do
+    {:a => nil}.blank?.should be_false
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'roys_extensions'
+
+Spec::Runner.configure do |config|
+
+end

data/spec/string_extensions_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+puts "string_extensions"
+describe "StringExtensions" do
+  it "should escape unicode binary in URL strings to %xx notation" do
+    s = "http://www.themoviedb.org/image/backdrops/23357/W\303\244hrend_Du_schliefst.jpg"
+    s.escape_unicode.should == "http://www.themoviedb.org/image/backdrops/23357/W%c3%a4hrend_Du_schliefst.jpg"
+  end
+
+  it "should strip angle bracket tags" do
+    s = 'Now is the <b>time</b> for all <i>good</i> Aggies'
+    s.strip_tags.should == 'Now is the time for all good Aggies'
+  end
+
+  it "should replace file extension" do
+    s = 'a/b.c'
+    s.ext('d').should == 'a/b.d'
+  end
+
+  it "should replace only the last file extension in the string" do
+    s = 'a.b.c'
+    s.ext('d').should == 'a.b.d'
+  end
+
+  it "should append file extension when there is not one" do
+    s = 'a/b/c'
+    s.ext('d').should == 'a/b/c.d'
+  end
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: royw-roys_extensions
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Roy Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-21 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: roy@wright.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/file_extensions.rb
+- lib/kernel_extensions.rb
+- lib/module_extensions.rb
+- lib/numeric_extensions.rb
+- lib/object_extensions.rb
+- lib/roys_extensions.rb
+- lib/string_extensions.rb
+- spec/file_extensions_spec.rb
+- spec/kernel_extensions_spec.rb
+- spec/module_extensions_spec.rb
+- spec/numeric_extensions_spec.rb
+- spec/object_extensions_spec.rb
+- spec/spec_helper.rb
+- spec/string_extensions_spec.rb
+has_rdoc: true
+homepage: http://github.com/royw/roys_extensions
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- spec/spec_helper.rb
+- spec/numeric_extensions_spec.rb
+- spec/object_extensions_spec.rb
+- spec/file_extensions_spec.rb
+- spec/string_extensions_spec.rb
+- spec/module_extensions_spec.rb
+- spec/kernel_extensions_spec.rb