visionmedia-rext 0.0.1

data/History.rdoc

@@ -0,0 +1,4 @@
+
+=== 0.0.1 / 2009-03-23
+
+* Initial release

data/Manifest

@@ -0,0 +1,19 @@
+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

data/README.rdoc

@@ -0,0 +1,97 @@
+
+= Rext
+
+This gem is primarily used for the Evolution CMS project, and its dependencies,
+however it is de-coupled and free to use within your own project. As to compliment
+existing extension libraries such as extlib, this library does not provide
+methods such as String#camelize etc.
+
+== Usage
+
+  require 'rext/all'
+
+  # or 
+
+  require 'rext/string'
+  require 'rext/hash'
+  ...
+
+  # or 
+
+  require 'rext/string/escape'
+  require 'rext/enumerable/every'
+  ...
+
+== Extensions
+
+Below are the methods currently provided by Rext.
+
+* String
+  - url_encode
+  - url_decode
+  - html_escape
+  - merge_word / add_class
+  - digitize
+  - wrap
+  - start_with?
+  - end_with?
+  - plural?
+  - singular?
+  - first
+  - last
+  - file
+  - files
+  - path
+
+* Integer
+  - ordanalize
+  - seconds, minutes, hours, days, ...
+  - to_seconds, to_minutes, to_hours, ...
+  - ago / before
+  - since / from_now
+
+* Hash
+  - delete_at / extract!
+
+* Time
+  - in_words_since / in_words_since_now
+  - to_time
+
+* Date
+  - to_time
+
+* Module
+  - chain
+
+* Proc
+  - yield_or_eval
+
+* Enumerable
+  - group_by
+  - every ( Copyright http://github.com/mynyml )
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+
+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, an d/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.
+ALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,16 @@
+
+$:.unshift 'lib'
+require 'rext'
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new "rext", Rext::VERSION do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "Ruby extensions"
+  p.url = "http://github.com/visionmedia/rext"
+  p.runtime_dependencies = []
+end
+
+Dir['tasks/**/*.rake'].sort.each { |lib| load lib }

data/Todo.rdoc

@@ -0,0 +1,14 @@
+
+== Major:
+
+* in_words_since should == to_words_since?
+* best method for allowing map and others to utilize instance_eval and Proxy
+* move time stuff to Numeric not Integer
+
+== Minor:
+
+* Nothing
+
+== Brainstorming:
+
+* Nothing

data/lib/rext.rb

@@ -0,0 +1,24 @@
+#--
+# Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+#
+# 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.
+#++
+
+require 'rext/version'

data/lib/rext/all.rb

@@ -0,0 +1,13 @@
+
+#--
+# Load all extensions.
+#++
+
+require 'rext/class'
+require 'rext/proc'
+require 'rext/enumerable'
+require 'rext/hash'
+require 'rext/integer'
+require 'rext/string'
+require 'rext/date'
+require 'rext/time'

data/lib/rext/integer.rb

@@ -0,0 +1,7 @@
+
+#--
+# Load Integer specific rext extensions.
+#++
+
+require 'rext/integer/helpers'
+require 'rext/integer/time'

data/lib/rext/integer/time.rb

@@ -0,0 +1,57 @@
+
+class Integer
+  
+  def seconds; self            end
+  def minutes; self * 60       end
+  def hours;   self * 3600     end
+  def days;    self * 86400    end
+  def weeks;   self * 604800   end
+  def months;  self * 2592000  end
+  def years;   self * 31471200 end
+
+  alias :second :seconds
+  alias :minute :minutes
+  alias :hour :hours
+  alias :day :days
+  alias :week :weeks
+  alias :month :months
+  alias :year :years
+
+  def to_minutes; self / 1.minute end
+  def to_hours;   self / 1.hour   end
+  def to_days;    self / 1.day    end
+  def to_weeks;   self / 1.week   end
+  def to_months;  self / 1.month  end
+  def to_years;   self / 1.year   end
+
+  ##
+  # Time before specified +time+, which defaults to now.
+  #
+  # === Examples
+  #
+  #   event = 10.days.ago
+  #   15.minutes.before event
+  #
+
+  def ago time = ::Time.now
+    time - self
+  end
+  alias :before :ago
+
+  ##
+  # Time since specified +time+, which defaults to now.
+  #
+  # === Examples
+  #
+  #   event = 1.year.ago
+  #   3.months.since event
+  # 
+  #   4.days.from_now
+  #
+
+  def since time = ::Time.now
+    time + self
+  end
+  alias :from_now :since
+  
+end

data/lib/rext/string.rb

@@ -0,0 +1,7 @@
+
+#--
+# Load String specific rext extensions.
+#++
+
+require 'rext/string/escape'
+require 'rext/string/helpers'

data/lib/rext/string/escape.rb

@@ -0,0 +1,32 @@
+
+require 'rack'
+
+class String
+  
+  ##
+  # URL encode. Shortcut for Rack::Utils.encode.
+
+  def url_encode
+    Rack::Utils.escape self
+  end
+
+  ##
+  # URL decode. Shortcut for Rack::Utils.unescape.
+
+  def url_decode
+    Rack::Utils.unescape self
+  end
+
+  ##
+  # Escape html entities. Shortcut for Rack::Utils.escape_html.
+  #
+  # === Examples
+  #
+  #   'im <strong>strong</strong>.escape_html  # => im &lt;strong&gt;strong&lt;/strong&gt;
+  #
+
+  def escape_html
+    Rack::Utils.escape_html self
+  end
+  
+end

data/lib/rext/string/helpers.rb

@@ -0,0 +1,151 @@
+
+require 'extlib'
+
+class String
+  
+  ##
+  # Returns a File instance.
+  #
+  # === Examples
+  #
+  #   'History.rdoc'.file.mtime
+  #
+  
+  def file
+    File.new self
+  end
+  
+  ##
+  # Returns a Pathname instance.
+  #
+  # === Examples
+  #
+  #   'lib'.path.join('foo').expand_path
+  #
+  
+  def path
+    require 'pathname'
+    Pathname.new self
+  end
+  
+  ##
+  # Returns an array of files matching self.
+  #
+  # === Examples
+  #
+  #  'lib/**/*.rb'.files
+  #
+  
+  def files
+    Dir[self]
+  end
+  
+  ##
+  # Merge the +word+ passed into the string. This
+  # is useful for adding classes which may already 
+  # exist in a string.
+  #
+  # === Examples 
+  #
+  #   'product'.merge_word('sold')        # => "product sold"
+  #   'product sold'.merge_word('sold')   # => "product sold"
+  #
+  
+  def merge_word word
+    self << " #{word}" unless split.include? word
+    self
+  end
+  alias :add_class :merge_word
+  
+  ##
+  # Digitize a string.
+  #
+  # === Examples:
+  #
+  #  '$100,000'.digitize  # => 100000
+  #
+  
+  def digitize
+    gsub /[^\d]/, ''
+  end
+  
+  ##
+  # Wrap a string with a +prefix+ and optional
+  # +suffix+. When the +suffix+ is not present
+  # the +prefix+ will be used.
+  #
+  # === Examples
+  #
+  #   'foo'.wrap('|')       # => |foo|
+  #   'foo'.wrap('(', ')')  # => (foo)
+  #
+  
+  def wrap prefix, suffix = nil
+    prefix + self + (suffix || prefix)
+  end
+  
+  ##
+  # Check if a string starts with another +string+.
+  #
+  # === Examples
+  #
+  #   'foo bar'.start_with? 'foo'  # => true
+  #
+
+  def start_with? string
+    index(string) == 0
+  end
+  
+  ##
+  # Check if a string ends with another +string+.
+  #
+  # === Examples
+  #
+  #   'foo bar'.end_with? 'bar'  # => true
+  #
+
+  def end_with? string
+    rindex(string) == length - string.length
+  end
+  
+  ##
+  # Determines if a string is plural.
+  #
+  # === Examples
+  #
+  #   'cookies'.plural?  # => true
+  #   'cookie'.plural?   # => false
+  #
+
+  def plural?
+    singular != self
+  end
+
+  ##
+  # Determines if a string is singular.
+  #
+  # === Examples
+  #
+  #   'cookies'.singular?  # => false
+  #   'cookie'.singular?   # => true
+  #
+
+  def singular?
+    !plural?
+  end
+
+  ##
+  # First character.
+
+  def first 
+    self[0,1]
+  end
+
+  ##
+  # Last character.
+
+  def last
+    self[-1, 1]
+  end
+  
+end

data/lib/rext/version.rb

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

data/rext.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rext}
+  s.version = "0.0.1"
+
+  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.has_rdoc = true
+  s.homepage = %q{http://github.com/visionmedia/rext}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rext", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rext}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Ruby extensions}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/integer_spec.rb

@@ -0,0 +1,36 @@
+
+require 'rext/integer'
+
+describe Integer do
+  describe "helpers" do
+    describe "#ordanalize" do
+      it "should convert integers to an ordanal string" do
+        1.ordinalize.should == '1st'
+        2.ordinalize.should == '2nd'
+        3.ordinalize.should == '3rd'
+        4.ordinalize.should == '4th'
+        11.ordinalize.should == '11th'
+        12.ordinalize.should == '12th'
+        13.ordinalize.should == '13th'
+      end
+    end
+  end
+  
+  describe "time" do
+    
+    describe "#ago / #before" do
+      it "should return the distance in time before now, or specified time" do
+        event = Time.mktime 1987, 5, 25
+        15.days.before(event).should == Time.mktime(1987, 5, 10)
+      end
+    end
+
+    describe "#since / #from_now" do
+      it "should return the distance in time from now, or specified time" do
+        event = Time.mktime 1987, 5, 25
+        5.days.since(event).should == Time.mktime(1987, 5, 30)
+      end
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+
+require 'rubygems'
+require 'rext/all'

data/spec/string_spec.rb

@@ -0,0 +1,95 @@
+
+require 'rext/string'
+
+describe String do
+  describe "helpers" do
+    
+    describe "#path" do
+      it "should return an instance of a pathname" do
+        'History.rdoc'.path.should be_an_instance_of(Pathname)
+      end
+    end
+    
+    describe "#files" do
+      it "should return result of Dir glob" do
+        'lib/*.*'.files.should be_an_instance_of(Array)
+      end
+    end
+    
+    describe "#file" do
+      it "should return an instance of a file" do
+        'History.rdoc'.file.should be_an_instance_of(File)
+      end
+    end
+        
+    describe "#add_class" do
+      it "should add a word that does not exist" do
+        'foo'.add_class('bar').should == 'foo bar'
+      end
+      
+      it "should not add the same word twice" do
+        'foo-bar bar'.add_class('bar').should == 'foo-bar bar'
+      end
+    end
+    
+    describe "#wrap" do
+      it "should wrap a string" do
+        'foo'.wrap('|').should == '|foo|'
+      end
+      
+      it "should wrap with optional suffix" do
+        'foo'.wrap('(', ')').should == '(foo)'
+      end
+    end
+    
+    describe "#start_with?" do
+      it "should check if a string starts with another" do
+        'foo bar'.start_with?('foo').should be_true
+        ' foo bar'.start_with?('foo').should_not be_true
+        'bar foo'.start_with?('foo').should_not be_true
+      end
+    end
+    
+    describe "#end_with?" do
+      it "should check if a string ends with another" do
+        'foo bar'.end_with?('bar').should be_true
+        'foo bar '.end_with?('bar').should_not be_true
+        'bar foo foo'.end_with?('foo').should be_true
+      end
+    end
+  
+    describe "#plural?" do
+      it "should check if a string is plural" do
+        'cookies'.should be_plural
+        'cookie'.should_not be_plural
+      end
+    end
+  
+    describe "#singular?" do
+      it "should check if a string is singular" do
+        'cookie'.should be_singular
+        'cookies'.should_not be_singular
+      end
+    end
+  
+    describe "#first" do
+      it "should return the first character" do
+        'foo'.first.should == 'f'
+      end
+    end
+  
+    describe "#last" do
+      it "should return the last character" do
+        'bar'.last.should == 'r'
+      end
+    end
+  
+    describe "#digitize" do
+      it "should leave only numeric characters" do
+        '$100,000'.digitize.should == '100000'
+        '$100,000'.digitize.to_i.should == 100_000
+      end
+    end
+    
+  end
+end

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open => [:docs] do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: visionmedia-rext
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Ruby extensions
+email: tj@vision-media.ca
+executables: []
+
+extensions: []
+
+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
+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
+has_rdoc: true
+homepage: http://github.com/visionmedia/rext
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Rext
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: rext
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby extensions
+test_files: []
+