rahoulb-rujitsu 0.1.7 → 0.1.8

data/CHANGELOG

@@ -1,3 +1,7 @@
+= Version 0.1.8 (2009-01-24)
+
+Added String#truncate + matching specs
+
 = Version 0.1.7 (2008-12-08)
 
 Added the limiter to Range#random_numbers

data/README.rdoc

@@ -41,6 +41,11 @@ The String class has an extension that strips out URL-unfriendly characters.
 
   ""$%hello!@ 123 there'".to_url # => "hello-123-there" 
 
+=== Truncating strings
+
+The String class has an extension that truncates it to a customisable length with a customisable suffix.
+
+  "this is a string".truncate(:length => 15) # => "this is a st..."
 
 === Grammar
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('rujitsu', '0.1.7') do | config | 
+Echoe.new('rujitsu', '0.1.8') do | config | 
   config.description = 'Various helper methods to smooth over Ruby development'
   config.url = 'http://github.com/rahoub/rujitsu'
   config.author = 'Brightbox Systems Ltd'

data/lib/rujitsu/string.rb

@@ -1,6 +1,26 @@
 class String
 	# Return a string that can be used as part of a url
+	# replaces basic "bad" characters with "-"
 	def to_url
 		self.downcase.gsub(/[^\-0-9a-z ]/, '').split.join('-')
 	end
+	
+	# Truncates a string to the specified length,
+	# and appends suffix if required
+	# 
+	# Options:
+	# * +length+ length to truncate string to. Includes the suffix in the length. Default is 50.
+	# * +suffix+ suffix to append to truncated string. Pass "" or false for no suffix. Default is "...".
+	# 
+	def truncate opts = {}
+	  opts[:length] ||= 50
+	  opts[:suffix] = opts.has_key?(:suffix) ? opts[:suffix] : "..."
+	  opts[:suffix] ||= ""
+    opts[:length] -= (opts[:suffix].length+1)
+    if opts[:length] > 0
+      self.length > opts[:length] ? self[0..opts[:length]] + opts[:suffix] : self
+    else
+      opts[:suffix][0..(opts[:length] += opts[:suffix].length)]
+    end
+  end
 end

data/rujitsu.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rujitsu}
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brightbox Systems Ltd"]
-  s.date = %q{2008-12-08}
+  s.date = %q{2009-01-24}
   s.description = %q{Various helper methods to smooth over Ruby development}
   s.email = %q{hello@brightbox.co.uk}
   s.extra_rdoc_files = ["CHANGELOG", "lib/rujitsu/fixnum.rb", "lib/rujitsu/grammar.rb", "lib/rujitsu/numeric.rb", "lib/rujitsu/range.rb", "lib/rujitsu/string.rb", "lib/rujitsu.rb", "README.rdoc", "tasks/rspec.rake"]

data/spec/string_spec.rb

@@ -18,4 +18,82 @@ describe String, "to_url" do
     "post-number-12345".to_url.should == "post-number-12345"
   end
 
+end
+
+describe String, "truncate" do
+  
+  it "should return shorter string unmodified with no params" do
+    str = 30.random_characters
+    # default length is 50
+    str.truncate.should == str
+  end
+  
+  it "should return shorter string unmodified with length param" do
+    str = "0123456789" # length 10
+    trunced = str.truncate(:length => 30)
+    trunced.length.should == 10
+    trunced.should == str
+  end
+  
+  it "should return shorter string unmodified with suffix param" do
+    str = "0123456789" # length 10
+    trunced = str.truncate(:suffix => "abcd")
+    trunced.length.should == 10
+    trunced.should == str
+  end
+  
+  it "should return shorter string unmodified with length and suffix params" do
+    str = "0123456789" # length 10
+    trunced = str.truncate(:length => 30, :suffix => "abcd")
+    trunced.length.should == 10
+    trunced.should == str
+  end
+  
+  it "should truncate longer string with no params" do
+    str = "this is a string with a really long length just to get above 50 characters"
+    # default length is 50
+    # default suffix is "..."
+    trunced = str.truncate
+    trunced.length.should == 50
+    trunced.should == "this is a string with a really long length just..."
+  end
+
+  it "should truncate longer string with length param" do
+    str = "123456789123456789" # length 11
+    trunced = str.truncate(:length => 10)
+    trunced.length.should == 10
+    trunced.should == "1234567..."
+  end
+  
+  it "should truncate longer string with suffix param" do
+    str = "this is a string with a really long length just to get above 50 characters"
+    # default length is 50
+    trunced = str.truncate(:suffix => "..abc")
+    trunced.length.should == 50
+    trunced.should == "this is a string with a really long length ju..abc"
+  end
+  
+  it "should truncate longer string with length and suffix param" do
+    str = "123456789123456789" # length 11
+    trunced = str.truncate(:length => 10, :suffix => "abde")
+    trunced.length.should == 10
+    trunced.should == "123456abde"
+  end
+  
+  it "should return truncated string with no suffix if suffix param is false" do
+    str = "this is a string with a really long length just to get above 50 characters"
+    # default length is 50
+    trunced = str.truncate(:suffix => false)
+    trunced.length.should == 50
+    trunced.should == "this is a string with a really long length just to"
+  end
+  
+  it "should return a string of length specified even when the suffix is longer" do
+    str = "this is a string" # => 16
+    suff = "this is a longer string" # => 23
+    trunced = str.truncate(:suffix => suff, :length => 10)
+    trunced.should == "this is a "
+    trunced.length.should == 10
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rahoulb-rujitsu
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Brightbox Systems Ltd
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-08 00:00:00 -08:00
+date: 2009-01-24 00:00:00 -08:00
 default_executable: 
 dependencies: []