rkh-monkey-lib 0.1.3 → 0.1.4

data/LICENSE

@@ -0,0 +1,27 @@
+copyright (c) 2009 Konstantin Haase.  All rights reserved.
+
+Developed by: Konstantin Haase
+              http://github.com/rkh/monkey-lib
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal with 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:
+  1. Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimers.
+  2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimers in the
+     documentation and/or other materials provided with the distribution.
+  3. Neither the name of Konstantin Haase, nor the names of other contributors
+     may be used to endorse or promote products derived from this Software without
+     specific prior written permission.
+
+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
+CONTRIBUTORS 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
+WITH THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,30 @@
+Sort of my own ruby extlib. There is a spec for everything and it is very clean.
+It does avoid monkey patching and relies on modules.
+
+= Template for extentiones
+
+Say we want to extend Object by adding some methods dealing with magic.
+This would go to the file lib/monkey/object/magic_stuff.rb:
+
+  module Monkey
+    module Object
+    
+      # It's magic!
+      module MagicStuff
+      
+        ::Object.send :include, self
+        
+        def hokus_pokus
+          Spell.perform(self)
+        end
+        
+        def vanish_in_thin_air
+          class << self
+            instance_methods.each { |m| undef_method(m) }
+          end
+        end
+      
+      end
+      
+    end
+  end

data/Rakefile

@@ -0,0 +1,49 @@
+require "spec/rake/spectask"
+require "rake/clean"
+require "rake/rdoctask"
+require "rake/gempackagetask"
+require "rubygems/specification"
+
+MONKEY_VERSION = "0.1.4"
+
+spec = Gem::Specification.new do |s|
+  s.name             = "monkey-lib"
+  s.version          = MONKEY_VERSION
+  s.authors          = ["Konstantin Haase"]
+  s.description      = "collection of sane ruby extensions"
+  s.email            = "konstantin.mailinglists@googlemail.com"
+  s.extra_rdoc_files = Dir["*.rdoc", "LICENSE", "lib/**/*.rb"]
+  s.files            = Dir["LICENSE", "Rakefile", "README.rdoc", "lib/**/*.rb", "spec/**/*.rb"]
+  s.has_rdoc         = true
+  s.homepage         = "http://github.com/rkh/monkey-lib"
+  s.require_paths    = ["lib"]
+  s.summary          = s.description
+  s.add_dependency "extlib"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{gem install pkg/monkey-lib-#{MONKEY_VERSION}.gem}
+end
+ 
+desc "create a gemspec file"
+task :make_spec do
+  File.open("monkey-lib.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end 
+  
+Rake::RDocTask.new("doc") do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options += %w[--all --inline-source --line-numbers --main README.rdoc --quiet
+    --tab-width 2 --title monkey-lib]
+  rdoc.rdoc_files.add ['*.rdoc', 'lib/**/*.rb']
+end
+
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = Dir.glob 'spec/**/*_spec.rb'
+end

data/lib/monkey-lib.rb

@@ -0,0 +1 @@
+require "monkey"

data/lib/monkey.rb

@@ -0,0 +1,4 @@
+require "monkey/object"
+require "monkey/hash"
+require "monkey/string"
+require "monkey/engine"

data/lib/monkey/engine.rb

@@ -0,0 +1,89 @@
+module Monkey
+  
+  # Makes sure we always have RUBY_ENGINE, RUBY_ENGINE_VERSION and RUBY_DESCRIPTION
+  module Engine
+
+    include Rubinius if defined? Rubinius
+
+    unless defined? RUBY_ENGINE
+      if defined? JRUBY_VERSION
+        ::RUBY_ENGINE = "jruby"
+      elsif defined? Rubinius
+        ::RUBY_ENGINE = "rbx"
+      else
+        ::RUBY_ENGINE = "ruby"
+      end
+    end
+
+    unless RUBY_ENGINE.frozen?
+      RUBY_ENGINE.replace "rbx" if RUBY_ENGINE == "rubinius"
+      RUBY_ENGINE.downcase!
+      RUBY_ENGINE.freeze
+    end
+
+    ::RUBY_ENGINE_VERSION = const_get("#{RUBY_ENGINE.upcase}_VERSION")
+
+    unless defined? RUBY_DESCRIPTION
+      ::RUBY_DESCRIPTION = "#{RUBY_ENGINE} #{RUBY_ENGINE_VERSION} "
+      unless RUBY_ENGINE == "ruby"
+        ::RUBY_DESCRIPTION << "(ruby #{RUBY_VERSION}"
+        ::RUBY_DESCRIPTION << " patchlevel #{RUBY_PATCHLEVEL}" if defined? RUBY_PATCHLEVEL
+        ::RUBY_DESCRIPTION << ") "
+      end
+      if defined? RUBY_RELEASE_DATE
+        ::RUBY_DESCRIPTION << "("
+        ::RUBY_DESCRIPTION << BUILDREV[0..8] << " " if defined? BUILDREV
+        ::RUBY_DESCRIPTION << RUBY_RELEASE_DATE << ") "
+      end
+      ::RUBY_DESCRIPTION << "[#{RUBY_PLATFORM}]"
+    end
+
+    def jruby?
+      RUBY_ENGINE == "jruby"
+    end
+
+    module_function :jruby?
+
+    def mri?
+      RUBY_ENGINE == "ruby"
+    end
+
+    module_function :mri?
+
+    def rbx?
+      RUBY_ENGINE == "rbx"
+    end
+
+    alias rubinius? rbx?
+    module_function :rbx?
+    module_function :rubinius?
+
+    def ironruby?
+      RUBY_ENGINE == "ironruby"
+    end
+
+    module_function :ironruby?
+
+    def macruby?
+      RUBY_ENGINE == "macruby"
+    end
+
+    module_function :macruby?
+
+    def ruby_engine(pretty = true)
+      return RUBY_ENGINE unless pretty
+      case RUBY_ENGINE
+      when "ruby"  then "CRuby"
+      when "rbx"   then "Rubinius"
+      when /ruby$/ then RUBY_ENGINE.capitalize.gsub("ruby", "Ruby")
+      end
+    end
+
+    module_function :ruby_engine
+
+  end
+  
+  extend Engine
+  include Engine
+
+end

data/lib/monkey/hash.rb

@@ -0,0 +1,4 @@
+require "extlib/class"
+require "extlib/hash"
+require "extlib/mash"
+require "monkey/hash/sub_hash"

data/lib/monkey/hash/sub_hash.rb

@@ -0,0 +1,23 @@
+module Monkey
+  module Hash
+    
+    # Adds sub hash ablilty (like Hash#[], but returning a hash rather than an array).
+    module SubHash
+      
+      ::Hash.send :include, self
+
+      # Example:
+      #   {:a => 42, :b => 23, :c => 1337}.sub_hash :a, :b, :d
+      #   # => {:a => 42, :b => 23} 
+      def sub_hash(*keys)
+        keys.inject({}) do |hash, key|
+          hash.merge! key => self[key] if include? key
+          hash
+        end
+      end
+      
+      alias subhash sub_hash
+      
+    end
+  end
+end

data/lib/monkey/object.rb

@@ -0,0 +1 @@
+require "monkey/object/backports"

data/lib/monkey/object/backports.rb

@@ -0,0 +1,24 @@
+module Monkey
+  module Object
+    
+    # Backports from newer / alternate ruby implementations.
+    module Backports
+      
+      ::Object.send :include, self
+
+      # From Ruby >= 1.8.7
+      def tap
+        yield self
+        self
+      end
+      
+      # From Rubinius
+      def metaclass
+        class << self
+          self
+        end
+      end
+      
+    end
+  end
+end

data/lib/monkey/string.rb

@@ -0,0 +1,2 @@
+require "extlib/string"
+require "monkey/string/like_pathname"

data/lib/monkey/string/like_pathname.rb

@@ -0,0 +1,36 @@
+require "pathname"
+require "extlib/pathname"
+
+module Monkey
+  module String
+    
+    # Adds Pathname behaviour to String.
+    module LikePathname
+      
+      ::String.send :include, self
+      
+      Pathname.instance_methods(false).each do |m|
+        # Syntax error in Ruby < 1.9:
+        #   define_method(m) { |*a, &b| ... }
+        next if "".respond_to? m or m.to_s == "to_path"
+        class_eval <<-EOS
+          def #{m}(*a, &b)
+            result = Pathname(self).#{m}(*a, &b)
+            return result unless result.is_a? Pathname
+            result.to_s
+          end
+        EOS
+      end
+      
+      #def method_missing(meth, *args, &block)
+      #  pathname = Pathname self
+      #  return super unless pathname.respond_to? meth
+      #  result = pathname.send(meth, *args, &block)
+      #  return result.to_s if result.is_a? Pathname
+      #  result
+      #end
+      
+    end
+        
+  end
+end

data/spec/monkey/engine_spec.rb

@@ -0,0 +1,18 @@
+require __FILE__.sub("monkey/engine_spec.rb", "spec_helper")
+require "monkey/engine"
+
+describe Monkey::Engine do
+  
+  it "defines RUBY_VERSION" do
+    defined?(RUBY_VERSION).should == "constant"
+  end
+  
+  it "defines RUBY_ENGINE_VERSION" do
+    defined?(RUBY_ENGINE_VERSION).should == "constant"
+  end
+  
+  it "defines RUBY_DESCRIPTION" do
+    defined?(RUBY_DESCRIPTION).should == "constant"
+  end
+  
+end

data/spec/monkey/hash/sub_hash_spec.rb

@@ -0,0 +1,15 @@
+require __FILE__.sub("monkey/hash/sub_hash_spec.rb", "spec_helper")
+require "monkey/hash/sub_hash"
+
+describe Monkey::Hash::SubHash do
+  
+  it "returns a hash with only the key-value-pairs requested for sub_hash" do
+    {:a => 10, :b => 20}.sub_hash(:a).should == {:a => 10}
+    {:a => 10, :b => 20}.sub_hash(:a, :b).should == {:a => 10, :b => 20} 
+  end
+  
+  it "should ignore keys passed to sub_hash, but not present" do
+    {:a => 10, :b => 20}.sub_hash(:a, :c).should == {:a => 10}
+  end
+  
+end

data/spec/monkey/object/backports_spec.rb

@@ -0,0 +1,24 @@
+require __FILE__.sub("monkey/object/backports_spec.rb", "spec_helper")
+require "monkey/object/backports"
+
+describe Monkey::Object::Backports do
+  
+  it "returns returns the reciever of #tap" do
+    obj = Object.new
+    obj.tap {}.should == obj
+    "example".tap {}.should == "example"
+  end
+  
+  it "passes the reciever of #tap to the given block" do
+    "foo".tap { |s| s.replace "bar" }.should == "bar"
+  end
+  
+  it "returns eigenclass for #metaclass" do
+    obj = Object.new
+    eigenclass = class << obj
+      self
+    end
+    obj.metaclass.should == eigenclass
+  end
+  
+end

data/spec/monkey/string/like_pathname_spec.rb

@@ -0,0 +1,271 @@
+require __FILE__.sub("monkey/string/like_pathname_spec.rb", "spec_helper")
+require "monkey/string/like_pathname"
+
+describe Monkey::String::LikePathname do
+  
+  before do
+    @strings = ["/usr/bin/ruby", ".", "..", ENV["HOME"]]
+    @methods = Pathname.instance_methods(false).reject do |m|
+      String.methods.include? m or m.to_s == "to_path"
+    end
+  end
+  
+  it "exposes sub_ext to String" do
+    @strings.each do |s|
+      s.sub_ext(".png").should == Pathname(s).sub_ext(".png").to_s
+    end
+  end
+
+  it "exposes cleanpath to String" do
+    @strings.each do |s|
+      s.cleanpath.should == Pathname(s).cleanpath.to_s
+    end
+  end
+
+  it "exposes realpath to String" do
+    @strings.each do |s|
+      s.realpath.should == Pathname(s).realpath.to_s
+    end
+  end
+
+  it "exposes parent to String" do
+    @strings.each do |s|
+      s.parent.should == Pathname(s).parent.to_s
+    end
+  end
+
+  it "exposes mountpoint? to String" do
+    @strings.each do |s|
+      s.mountpoint?.should == Pathname(s).mountpoint?
+    end
+  end
+
+  it "exposes root? to String" do
+    @strings.each do |s|
+      s.root?.should == Pathname(s).root?
+    end
+  end
+
+  it "exposes absolute? to String" do
+    @strings.each do |s|
+      s.absolute?.should == Pathname(s).absolute?
+    end
+  end
+
+  it "exposes relative? to String" do
+    @strings.each do |s|
+      s.relative?.should == Pathname(s).relative?
+    end
+  end
+
+  it "exposes each_filename to String" do
+    @strings.each do |s|
+      s.each_filename.to_a.should == Pathname(s).each_filename.to_a
+    end
+  end
+
+  it "exposes join to String" do
+    @strings.each do |s|
+      s.join.should == Pathname(s).join.to_s
+    end
+  end
+
+  it "exposes children to String" do
+    @strings.each do |s|
+      s.children.should == Pathname(s).children if s.directory?
+    end
+  end
+
+  it "exposes atime to String" do
+    @strings.each do |s|
+      s.atime.should == Pathname(s).atime
+    end
+  end
+
+  it "exposes ctime to String" do
+    @strings.each do |s|
+      s.ctime.should == Pathname(s).ctime
+    end
+  end
+
+  it "exposes mtime to String" do
+    @strings.each do |s|
+      s.mtime.should == Pathname(s).mtime
+    end
+  end    
+  
+  it "exposes ftype to String" do
+    @strings.each do |s|
+      s.ftype.should == Pathname(s).ftype.to_s
+    end
+  end
+
+  it "exposes basename to String" do
+    @strings.each do |s|
+      s.basename.should == Pathname(s).basename.to_s
+    end
+  end
+
+  it "exposes dirname to String" do
+    @strings.each do |s|
+      s.dirname.should == Pathname(s).dirname.to_s
+    end
+  end
+
+  it "exposes extname to String" do
+    @strings.each do |s|
+      s.extname.should == Pathname(s).extname.to_s
+    end
+  end
+
+  it "exposes expand_path to String" do
+    @strings.each do |s|
+      s.expand_path.should == Pathname(s).expand_path.to_s
+    end
+  end
+
+  it "exposes blockdev? to String" do
+    @strings.each do |s|
+      s.blockdev?.should == Pathname(s).blockdev?
+    end
+  end
+
+  it "exposes chardev? to String" do
+    @strings.each do |s|
+      s.chardev?.should == Pathname(s).chardev?
+    end
+  end
+
+  it "exposes executable? to String" do
+    @strings.each do |s|
+      s.executable?.should == Pathname(s).executable?
+    end
+  end
+
+  it "exposes executable_real? to String" do
+    @strings.each do |s|
+      s.executable_real?.should == Pathname(s).executable_real?
+    end
+  end
+
+  it "exposes exist? to String" do
+    @strings.each do |s|
+      s.exist?.should == Pathname(s).exist?
+    end
+  end
+
+  it "exposes grpowned? to String" do
+    @strings.each do |s|
+      s.grpowned?.should == Pathname(s).grpowned?
+    end
+  end
+
+  it "exposes directory? to String" do
+    @strings.each do |s|
+      s.directory?.should == Pathname(s).directory?
+    end
+  end
+
+  it "exposes file? to String" do
+    @strings.each do |s|
+      s.file?.should == Pathname(s).file?
+    end
+  end
+
+  it "exposes pipe? to String" do
+    @strings.each do |s|
+      s.pipe?.should == Pathname(s).pipe?
+    end
+  end
+
+  it "exposes socket? to String" do
+    @strings.each do |s|
+      s.socket?.should == Pathname(s).socket?
+    end
+  end
+
+  it "exposes owned? to String" do
+    @strings.each do |s|
+      s.owned?.should == Pathname(s).owned?
+    end
+  end
+
+  it "exposes readable? to String" do
+    @strings.each do |s|
+      s.readable?.should == Pathname(s).readable?
+    end
+  end
+
+  it "exposes world_readable? to String" do
+    @strings.each do |s|
+      s.world_readable?.should == Pathname(s).world_readable?
+    end
+  end
+
+  it "exposes readable_real? to String" do
+    @strings.each do |s|
+      s.readable_real?.should == Pathname(s).readable_real?
+    end
+  end
+
+  it "exposes setuid? to String" do
+    @strings.each do |s|
+      s.setuid?.should == Pathname(s).setuid?
+    end
+  end
+
+  it "exposes setgid? to String" do
+    @strings.each do |s|
+      s.setgid?.should == Pathname(s).setgid?
+    end
+  end
+
+  it "exposes size? to String" do
+    @strings.each do |s|
+      s.size?.should == Pathname(s).size?
+    end
+  end
+
+  it "exposes sticky? to String" do
+    @strings.each do |s|
+      s.sticky?.should == Pathname(s).sticky?
+    end
+  end
+
+  it "exposes symlink? to String" do
+    @strings.each do |s|
+      s.symlink?.should == Pathname(s).symlink?
+    end
+  end
+
+  it "exposes writable? to String" do
+    @strings.each do |s|
+      s.writable?.should == Pathname(s).writable?
+    end
+  end
+
+  it "exposes world_writable? to String" do
+    @strings.each do |s|
+      s.world_writable?.should == Pathname(s).world_writable?
+    end
+  end
+
+  it "exposes writable_real? to String" do
+    @strings.each do |s|
+      s.writable_real?.should == Pathname(s).writable_real?
+    end
+  end
+
+  it "exposes zero? to String" do
+    @strings.each do |s|
+      s.zero?.should == Pathname(s).zero?
+    end
+  end
+
+  it "exposes entries to String" do
+    @strings.each do |s|
+      s.entries.should == Pathname(s).entries if s.directory?
+    end
+  end
+    
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$LOAD_PATH.unshift File.expand_path(__FILE__.sub("spec/spec_helper.rb", "lib"))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rkh-monkey-lib
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Konstantin Haase
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-16 00:00:00 -07:00
+date: 2009-07-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,11 +28,37 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
-files: []
-
-has_rdoc: true
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- lib/monkey/engine.rb
+- lib/monkey/hash/sub_hash.rb
+- lib/monkey/hash.rb
+- lib/monkey/object/backports.rb
+- lib/monkey/object.rb
+- lib/monkey/string/like_pathname.rb
+- lib/monkey/string.rb
+- lib/monkey-lib.rb
+- lib/monkey.rb
+files: 
+- LICENSE
+- Rakefile
+- README.rdoc
+- lib/monkey/engine.rb
+- lib/monkey/hash/sub_hash.rb
+- lib/monkey/hash.rb
+- lib/monkey/object/backports.rb
+- lib/monkey/object.rb
+- lib/monkey/string/like_pathname.rb
+- lib/monkey/string.rb
+- lib/monkey-lib.rb
+- lib/monkey.rb
+- spec/monkey/engine_spec.rb
+- spec/monkey/hash/sub_hash_spec.rb
+- spec/monkey/object/backports_spec.rb
+- spec/monkey/string/like_pathname_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
 homepage: http://github.com/rkh/monkey-lib
 post_install_message: 
 rdoc_options: []
@@ -56,7 +82,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: collection of sane ruby extensions
 test_files: []