visionmedia-rext 0.0.1 → 0.0.2

data/History.rdoc

@@ -1,4 +1,9 @@
 
+=== 0.0.2 / 2009-03-23
+
+* Added Proc#yield_or_eval docs
+* Renamed class/helpers to module/helpers
+
 === 0.0.1 / 2009-03-23
 
 * Initial release

data/Manifest

@@ -1,18 +1,40 @@
+benchmarks/enumerable.rb
+benchmarks/proc.rb
 History.rdoc
 lib/rext/all.rb
+lib/rext/date/helpers.rb
+lib/rext/date.rb
+lib/rext/enumerable/helpers.rb
+lib/rext/enumerable.rb
+lib/rext/hash/helpers.rb
+lib/rext/hash.rb
+lib/rext/integer/helpers.rb
 lib/rext/integer/time.rb
 lib/rext/integer.rb
+lib/rext/module/helpers.rb
+lib/rext/module.rb
+lib/rext/proc/helpers.rb
+lib/rext/proc.rb
 lib/rext/string/escape.rb
 lib/rext/string/helpers.rb
 lib/rext/string.rb
+lib/rext/time/helpers.rb
+lib/rext/time.rb
 lib/rext/version.rb
 lib/rext.rb
 Manifest
 Rakefile
 README.rdoc
+rext.gemspec
+spec/date_spec.rb
+spec/enumerable_spec.rb
+spec/hash_spec.rb
 spec/integer_spec.rb
+spec/module_spec.rb
 spec/spec_helper.rb
 spec/string_spec.rb
+spec/time_spec.rb
+tasks/benchmark.rake
 tasks/docs.rake
 tasks/gemspec.rake
 tasks/spec.rake

data/benchmarks/enumerable.rb

@@ -0,0 +1,14 @@
+
+list = %w( just some random foo bar like cookies )
+
+benchmark 'Enumerable#group_by', :times => $times do
+  report 'with block' do 
+    list.group_by { |item| item.length } 
+  end
+  report 'with evaled block' do 
+    list.group_by { length }
+  end
+  report 'with proxy' do 
+    list.group_by.length
+  end
+end

data/benchmarks/proc.rb

@@ -0,0 +1,24 @@
+
+def yield_or_eval_test &block
+  block.yield_or_eval 'foo'
+end
+
+def manual &block
+  foo = 'foo'
+  if block.arity > 0
+    yield foo
+  else
+    foo.instance_eval &block
+  end
+end
+
+benchmark 'Proc', :times => $times do
+  report '#yield_or_eval' do 
+    yield_or_eval_test { length }
+    yield_or_eval_test { |foo| foo.length }
+  end
+  report 'manual arity check' do 
+    manual { length }
+    manual { |foo| foo.length }
+  end
+end

data/lib/rext/all.rb

@@ -3,7 +3,7 @@
 # Load all extensions.
 #++
 
-require 'rext/class'
+require 'rext/module'
 require 'rext/proc'
 require 'rext/enumerable'
 require 'rext/hash'

data/lib/rext/date/helpers.rb

@@ -0,0 +1,12 @@
+
+class Date
+  
+  ##
+  # Convert Date to a Time instance.
+  #
+  
+  def to_time
+    Time.utc year, month, day
+  end
+  
+end

data/lib/rext/date.rb

@@ -0,0 +1,6 @@
+
+#--
+# Load Date specific rext extensions.
+#++
+
+require 'rext/date/helpers'

data/lib/rext/enumerable/helpers.rb

@@ -0,0 +1,75 @@
+
+require 'rext/module/helpers'
+require 'rext/proc/helpers'
+
+module Enumerable
+  
+  ##
+  # Proxy
+  #
+  # The enumerable proxy class is utilized to
+  # allow methods such as #group_by, #map, and others
+  # to provide a method call alternative to a block.
+  #
+  # For example words.group_by { |word| word.length } can
+  # be replaced by words.group_by_.length
+  #
+  # === See
+  #
+  # * Enumerable#proxy
+  #
+  
+  class Proxy
+    instance_methods.each { |m| undef_method m unless m.match(/^__/) }
+    
+    def initialize object, meth
+      @object, @method = object, meth
+    end
+
+    def method_missing meth, *args, &block
+      @object.__send__(@method) { |o| o.__send__(meth, *args, &block) }
+    end
+  end
+  
+  ##
+  # Shortcut for Proxy.new self, +meth+.
+  
+  def proxy meth
+    Proxy.new self, meth
+  end
+    
+  ##
+  # Return a hash grouped by +block+.
+  #
+  # === Examples
+  #
+  #   words = %w( just some foo bar )
+  #   words.group_by { |word| word.length }  # => {3=>["foo", "bar"], 4=>["just", "some"]}
+  #   words.group_by { length }              # => {3=>["foo", "bar"], 4=>["just", "some"]}
+  #   words.group_by.length                  # => {3=>["foo", "bar"], 4=>["just", "some"]}
+  #
+
+  def group_by &block
+    return proxy(:group_by) unless block
+    inject({}) do |hash, value|
+      (hash[block.yield_or_eval(value)] ||= []) << value
+      hash
+    end
+  end
+  
+  ##
+  # Sexy Symbol#to_proc replacement for mapping enums.
+  #
+  # === Examples
+  #    
+  #   names = %w( tj scott joe bob )
+  #   names.every.length.join          # => 2533
+  #   names.every.empty?.any?          # => false
+  #   names.every { length > 4 }.all?  # => true
+  #
+  
+  def every &block
+    block ? proxy(:map).instance_eval(&block) : proxy(:map)
+  end
+  
+end

data/lib/rext/enumerable.rb

@@ -0,0 +1,6 @@
+
+#--
+# Load Enumerable specific rext extensions.
+#++
+
+require 'rext/enumerable/helpers'

data/lib/rext/hash/helpers.rb

@@ -0,0 +1,23 @@
+
+class Hash
+  
+  ##
+  # Delete key-value pairs, returning the values found
+  # using the +keys+ passed. Aliased as extract!
+  #
+  # === Examples
+  #
+  #   options = { :width => 25, :height => 100 }
+  #   width, height = options.delete_at :width, :height  
+  #
+  #   width   # => 25
+  #   height  # => 100
+  #   options # => {}
+  #
+  
+  def delete_at *keys
+    keys.map { |key| delete key }
+  end
+  alias :extract! :delete_at
+  
+end

data/lib/rext/hash.rb

@@ -0,0 +1,6 @@
+
+#--
+# Load Hash specific rext extensions.
+#++
+
+require 'rext/hash/helpers'

data/lib/rext/integer/helpers.rb

@@ -0,0 +1,29 @@
+
+class Integer
+  
+  ##
+  # Ordinalize turns a number into an ordinal string used to denote the
+  # position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
+  #
+  # === Examples
+  #
+  #   1.ordinalize     # => "1st"
+  #   2.ordinalize     # => "2nd"
+  #   1002.ordinalize  # => "1002nd"
+  #   1003.ordinalize  # => "1003rd"
+  #
+  
+  def ordinalize
+    if (11..13).include? self % 100
+      "#{self}th"
+    else
+      case self % 10
+      when 1 ; "#{self}st"
+      when 2 ; "#{self}nd"
+      when 3 ; "#{self}rd"
+      else     "#{self}th"
+      end
+    end
+  end
+  
+end

data/lib/rext/module/helpers.rb

@@ -0,0 +1,11 @@
+
+class Module
+  
+  ##
+  # Shortcut for including an anonymous module.
+  
+  def chain &block
+    include Module.new(&block)
+  end
+  
+end

data/lib/rext/module.rb

@@ -0,0 +1,6 @@
+
+#--
+# Load Module specific rext extensions.
+#++
+
+require 'rext/module/helpers'

data/lib/rext/proc/helpers.rb

@@ -0,0 +1,22 @@
+
+class Proc
+  
+  ##
+  # Yield or instance evaluate the +object+ passed
+  # based on this proc's arity.
+  #
+  # === Examples
+  #
+  #   def foo &block
+  #     block.yield_or_eval 'bar'
+  #   end
+  #
+  #   foo { |v| v.length }  # => 3
+  #   foo { length }        # => 3
+  #
+  
+  def yield_or_eval object
+    arity > 0 ? self.call(object) : object.instance_eval(&self)
+  end
+  
+end

data/lib/rext/proc.rb

@@ -0,0 +1,7 @@
+
+
+#--
+# Load Proc specific rext extensions.
+#++
+
+require 'rext/proc/helpers'

data/lib/rext/time/helpers.rb

@@ -0,0 +1,43 @@
+
+class Time
+  
+  def to_time #:nodoc:
+    self
+  end
+  
+  ##
+  # Time in words since +time+ or now.
+  #
+  # === Examples
+  #
+  #   5.seconds.ago.in_words_since_now  # => less than one minute
+  #   5.days.ago.in_words_since_now     # => 5 days
+  #   1.month.ago.in_words_since_now    # => 1 month
+  #   101.years.ago.in_words_since_now  # => hundreds of years
+  #
+  #   "the article was published #{article.created_at.in_words_since_now} ago"  
+  #   # => the article was published 15 minutes ago
+  #
+
+  def in_words_since time = Time.now
+    return if self > time
+    seconds = (time - self).to_i
+    # TODO: abstract this out
+    pluralize = lambda do |type| 
+      n = seconds.send(:"to_#{type}s")
+      n == 1 ? "one #{type}" : "#{n} #{type}s"
+    end
+    case seconds
+    when 0..59                ; 'less than one minute'
+    when 1.minute..59.minutes ; pluralize[:minute]
+    when 1.hour..23.hours     ; pluralize[:hour]
+    when 1.day..6.days        ; pluralize[:day]
+    when 1.week..3.weeks      ; pluralize[:week]
+    when 1.month..11.months   ; pluralize[:month]
+    when 1.year..99.years     ; pluralize[:year]
+    else 'hundreds of years'
+    end
+  end
+  alias :in_words_since_now :in_words_since
+  
+end

data/lib/rext/time.rb

@@ -0,0 +1,6 @@
+
+#--
+# Load Time specific rext extensions.
+#++
+
+require 'rext/time/helpers'

data/lib/rext/version.rb

@@ -1,4 +1,4 @@
 
 module Rext
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/rext.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rext}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
   s.date = %q{2009-03-23}
   s.description = %q{Ruby extensions}
   s.email = %q{tj@vision-media.ca}
-  s.extra_rdoc_files = ["lib/rext/all.rb", "lib/rext/integer/time.rb", "lib/rext/integer.rb", "lib/rext/string/escape.rb", "lib/rext/string/helpers.rb", "lib/rext/string.rb", "lib/rext/version.rb", "lib/rext.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
-  s.files = ["History.rdoc", "lib/rext/all.rb", "lib/rext/integer/time.rb", "lib/rext/integer.rb", "lib/rext/string/escape.rb", "lib/rext/string/helpers.rb", "lib/rext/string.rb", "lib/rext/version.rb", "lib/rext.rb", "Manifest", "Rakefile", "README.rdoc", "spec/integer_spec.rb", "spec/spec_helper.rb", "spec/string_spec.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "Todo.rdoc", "rext.gemspec"]
+  s.extra_rdoc_files = ["lib/rext/all.rb", "lib/rext/date/helpers.rb", "lib/rext/date.rb", "lib/rext/enumerable/helpers.rb", "lib/rext/enumerable.rb", "lib/rext/hash/helpers.rb", "lib/rext/hash.rb", "lib/rext/integer/helpers.rb", "lib/rext/integer/time.rb", "lib/rext/integer.rb", "lib/rext/module/helpers.rb", "lib/rext/module.rb", "lib/rext/proc/helpers.rb", "lib/rext/proc.rb", "lib/rext/string/escape.rb", "lib/rext/string/helpers.rb", "lib/rext/string.rb", "lib/rext/time/helpers.rb", "lib/rext/time.rb", "lib/rext/version.rb", "lib/rext.rb", "README.rdoc", "tasks/benchmark.rake", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["benchmarks/enumerable.rb", "benchmarks/proc.rb", "History.rdoc", "lib/rext/all.rb", "lib/rext/date/helpers.rb", "lib/rext/date.rb", "lib/rext/enumerable/helpers.rb", "lib/rext/enumerable.rb", "lib/rext/hash/helpers.rb", "lib/rext/hash.rb", "lib/rext/integer/helpers.rb", "lib/rext/integer/time.rb", "lib/rext/integer.rb", "lib/rext/module/helpers.rb", "lib/rext/module.rb", "lib/rext/proc/helpers.rb", "lib/rext/proc.rb", "lib/rext/string/escape.rb", "lib/rext/string/helpers.rb", "lib/rext/string.rb", "lib/rext/time/helpers.rb", "lib/rext/time.rb", "lib/rext/version.rb", "lib/rext.rb", "Manifest", "Rakefile", "README.rdoc", "rext.gemspec", "spec/date_spec.rb", "spec/enumerable_spec.rb", "spec/hash_spec.rb", "spec/integer_spec.rb", "spec/module_spec.rb", "spec/spec_helper.rb", "spec/string_spec.rb", "spec/time_spec.rb", "tasks/benchmark.rake", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "Todo.rdoc"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/visionmedia/rext}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rext", "--main", "README.rdoc"]

data/spec/date_spec.rb

@@ -0,0 +1,15 @@
+
+require 'rext/date'
+
+describe Date do
+  describe "helpers" do
+    
+    describe "#to_time" do
+      it "should convert to a Time instance" do
+        event = Date.parse('may 25th 1987')
+        event.to_time.should be_an_instance_of(Time)
+      end
+    end
+    
+  end
+end

data/spec/enumerable_spec.rb

@@ -0,0 +1,45 @@
+
+require 'rext/enumerable'
+
+describe Enumerable do
+  
+  describe "#every" do
+    it "should map a method call" do
+      list = %w( cookies icecream sugar )
+      list.every.length.should == [7, 8 ,5]
+    end
+    
+    it "should allow mapping shortcuts using a block" do
+      people = []
+      people << mock('Person', :name => 'TJ')
+      people << mock('Person', :name => 'Scott')
+      people.every { name.length }.should == [2, 5]
+    end
+  end
+  
+  describe "helpers" do
+    describe "#group_by" do
+      before :each do
+        @enum = 'foo', :bar, 1, 2, 3
+        @results = {
+          String => ['foo'],
+          Symbol => [:bar],
+          Fixnum => [1, 2, 3]
+        }
+      end
+      
+      it "should group an enum" do
+        @enum.group_by { |v| v.class }.should == @results
+      end
+      
+      it "should group using instance evaluated block" do
+        @enum.group_by { self.class }.should == @results
+      end
+      
+      it "should group by method call" do
+        @enum.group_by.class.should == @results
+      end
+    end
+  end
+  
+end

data/spec/hash_spec.rb

@@ -0,0 +1,18 @@
+
+require 'rext/hash'
+
+describe Hash do
+  describe "helpers" do
+    
+    describe "#delete_at" do
+      it "should delete several keys, returning their values when present" do
+        options = { :foo => 1, :bar => 2 }
+        foo, bar, does_not_exist = options.delete_at :foo, :bar, :does_not_exist
+        foo.should == 1
+        bar.should == 2
+        does_not_exist.should be_nil
+      end
+    end
+    
+  end  
+end

data/spec/module_spec.rb

@@ -0,0 +1,38 @@
+
+require 'rext/module'
+
+describe Module do
+  describe "helpers" do
+    
+    describe "#chain" do
+      it "should allow chaining via super" do
+        class Foo
+          def method_missing meth
+            if meth.to_s =~ /^say_(\w+)/
+              "said #{$1}"
+            else
+              super
+            end
+          end
+        end
+        
+        class Foo
+          chain {
+            def method_missing meth
+              if meth.to_s =~ /^ask_for_(\w+)/
+                "asked for #{$1}"
+              else
+                super
+              end
+            end
+          }
+        end
+        
+        Foo.new.ask_for_array.should == 'asked for array'
+        Foo.new.say_hello.should == 'said hello'
+        lambda { Foo.new.does_not_exist }.should raise_error(NoMethodError)
+      end
+    end
+    
+  end
+end

data/spec/time_spec.rb

@@ -0,0 +1,23 @@
+
+require 'rext/time'
+
+describe Time do
+  describe "helpers" do
+    
+    describe "#in_words_since" do
+      it "should convert time lost to words" do
+        event = Time.now - 5.seconds
+        event.in_words_since_now.should == 'less than one minute'
+        event -= 1.minute
+        event.in_words_since_now.should == 'one minute'
+        event -= 2.minutes
+        event.in_words_since_now.should == '3 minutes'
+        event -= 5.years
+        event.in_words_since_now.should == '5 years'
+        event -= 100.years
+        event.in_words_since_now.should == 'hundreds of years'
+      end
+    end
+    
+  end
+end

data/tasks/benchmark.rake

@@ -0,0 +1,13 @@
+
+desc 'Run benchmark suites n TIMES, defaulting to 1000'
+task :benchmark do
+  $times = ENV['TIMES'] || 1000
+  begin
+    require 'rext/all'
+    require 'rubygems'
+    require 'rgauge'
+  rescue LoadError
+    abort 'visionmedia-rgauge is required, grab it from github'
+  end
+  Dir['benchmarks/*.rb'].each { |f| load f } 
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-rext
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -21,38 +21,73 @@ extensions: []
 
 extra_rdoc_files: 
 - lib/rext/all.rb
+- lib/rext/date/helpers.rb
+- lib/rext/date.rb
+- lib/rext/enumerable/helpers.rb
+- lib/rext/enumerable.rb
+- lib/rext/hash/helpers.rb
+- lib/rext/hash.rb
+- lib/rext/integer/helpers.rb
 - lib/rext/integer/time.rb
 - lib/rext/integer.rb
+- lib/rext/module/helpers.rb
+- lib/rext/module.rb
+- lib/rext/proc/helpers.rb
+- lib/rext/proc.rb
 - lib/rext/string/escape.rb
 - lib/rext/string/helpers.rb
 - lib/rext/string.rb
+- lib/rext/time/helpers.rb
+- lib/rext/time.rb
 - lib/rext/version.rb
 - lib/rext.rb
 - README.rdoc
+- tasks/benchmark.rake
 - tasks/docs.rake
 - tasks/gemspec.rake
 - tasks/spec.rake
 files: 
+- benchmarks/enumerable.rb
+- benchmarks/proc.rb
 - History.rdoc
 - lib/rext/all.rb
+- lib/rext/date/helpers.rb
+- lib/rext/date.rb
+- lib/rext/enumerable/helpers.rb
+- lib/rext/enumerable.rb
+- lib/rext/hash/helpers.rb
+- lib/rext/hash.rb
+- lib/rext/integer/helpers.rb
 - lib/rext/integer/time.rb
 - lib/rext/integer.rb
+- lib/rext/module/helpers.rb
+- lib/rext/module.rb
+- lib/rext/proc/helpers.rb
+- lib/rext/proc.rb
 - lib/rext/string/escape.rb
 - lib/rext/string/helpers.rb
 - lib/rext/string.rb
+- lib/rext/time/helpers.rb
+- lib/rext/time.rb
 - lib/rext/version.rb
 - lib/rext.rb
 - Manifest
 - Rakefile
 - README.rdoc
+- rext.gemspec
+- spec/date_spec.rb
+- spec/enumerable_spec.rb
+- spec/hash_spec.rb
 - spec/integer_spec.rb
+- spec/module_spec.rb
 - spec/spec_helper.rb
 - spec/string_spec.rb
+- spec/time_spec.rb
+- tasks/benchmark.rake
 - tasks/docs.rake
 - tasks/gemspec.rake
 - tasks/spec.rake
 - Todo.rdoc
-- rext.gemspec
 has_rdoc: true
 homepage: http://github.com/visionmedia/rext
 post_install_message: