summary 0.6.0

data/CHANGELOG

@@ -0,0 +1,4 @@
+v0.6.0. Code review, Removed ActiveSupport dependence
+v0.5.0. Added support for specific terminator (including html), Replaced the test units to Rspec specs, Now the summary method builds an object Summarize, Better support for versioning (MAJOR, TINY, PATCH constants)
+v0.2. Adding the support as Ruby on Rails plugin
+v0.1. First release!

data/Manifest

@@ -0,0 +1,9 @@
+CHANGELOG
+Manifest
+README.rdoc
+Rakefile
+lib/summary.rb
+rails/init.rb
+spec/spec_helper.rb
+spec/summary_spec.rb
+summary.gemspec

data/README.rdoc

@@ -0,0 +1,62 @@
+= Summary
+
+== Description:
+
+This is a simple gem that generates introduction text from a long text, it will always break the text at the end of the last word near to the limit you informed as argument.
+
+== Synopsis
+
+  text = <<-TEXT
+    Cras eleifend sodales sem. Ut nec metus. Nulla sed nisl.
+  Praesent malesuada dui rhoncus quam. Aliquam ultricies. Praesent commodo.
+
+    Nam nec pede. Pellentesque egestas, urna vel accumsan venenatis, mi metus sagittis augue,
+  sed hendrerit nunc felis eget neque. Fusce vel massa. Quisque ligula enim,
+  tempor sed, lacinia non, malesuada ac, enim. Curabitur at enim scelerisque
+  neque egestas luctus. Mauris lacinia varius diam.'
+  TEXT
+
+  text.summary # Cras eleifend sodales sem. Ut nec metus. Nulla sed nisl. Praesent malesuada dui rhoncus quam...
+  text.summary(50) # Cras eleifend sodales sem. Ut nec metus. Nulla...
+  text.summary(50, ' :)') # Cras eleifend sodales sem. Ut nec metus. Nulla :)
+  text.summary(50, '... <a href="/page.html">read more</a>') # Cras eleifend sodales sem. Ut nec... <a href="/page.html">read more</a>
+
+== Requirements
+
+* Ruby
+
+== Install
+
+=== as Ruby on Rails plugin
+
+  script/plugin install git://github.com/azisaka/summary.git
+
+== Collaborators
+
+* Bruno Azisaka Maciel
+* Marcio Trindade [http://marciotrindade.com]
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2008 Philipe Casarotte
+
+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/Rakefile

@@ -0,0 +1,11 @@
+require 'echoe'
+Echoe.new('summary') do |p|
+  p.project = 'summary'
+  p.author = 'Bruno Azisaka Maciel'
+  p.email = 'bruno [at] bubble [dot] com [dot] br'
+  p.url = 'http://github.com/azisaka/summary'
+  p.summary = 'This is a simple gem that generates introduction text from a long text, it will always break the text at the end of the last word near to the limit you informed as argument.'
+  # p.url = ''
+  # p.docs_host = ''
+  p.retain_gemspec = true
+end

data/lib/summary.rb

@@ -0,0 +1,62 @@
+module Summary
+  MAJOR = '0'
+  TINY = '6'
+  PATCH = '0'
+  VERSION = [MAJOR, TINY, PATCH] * '.'
+  
+  module String
+    # This method sanitizes the string removing html tags, \t \n \r characters, and duplicated blank spaces.
+    # To use it just do:
+    #
+    #   "your string".summary
+    #
+    # or with a custom limit
+    #
+    #   "your string".summary(10)
+    #
+    # or with a custom limit and another terminator
+    #
+    #   "your string".summary(10, ' :)')
+    #
+    # or with a custom limit and a html terminator
+    #
+    #   "your string".summary(10, '... <a href="#">read more</a>')
+    def summary(size=100, terminator = '...')
+      Summarize.new(self, size, terminator).summary
+    end
+  end
+
+  class Summarize
+    def initialize(text, size = 100, terminator = '...')
+      @text = text
+      @size = size
+      @terminator = terminator
+    end
+
+    # Checks the need of "summarize" the string. When it is needed, the string is splitted.
+    # Then the last dot is removed and the separator and terminator are pushed into the resultant string.
+    def summary
+      if pure.size > @size
+      	@text = pure[0...pure[0..(@size-backspace)].rindex(' ')]
+      	@text.gsub(/\.$/,'') + @terminator
+      else
+        pure
+    	end
+    end
+
+    protected
+    # It cleans up the text removing the html tags, break lines and white spaces
+    def pure
+      @pure ||= @text.strip.gsub(/<(.|\n)+?>|(\t|\n|\r)+/,'').gsub(/\s+/,' ')
+    end
+
+    # Measures the space needed by the terminator.
+    # Let's say you want a string with 50 chars, and your terminator is a '...'.
+    # That means your string can only have 47 chars + 3 chars from your terminator.
+    def backspace
+      (@terminator =~ /<(.|\n)+?>/ ? @terminator.gsub(/<(.|\n)+?>/,'') : @terminator).size
+    end
+  end
+end
+
+String.send(:include, Summary::String)

data/rails/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../lib/summary'

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/summary'
+
+module Summary
+  module Matchers
+    class SummarizableOf
+      def initialize(size)
+        @size = size
+      end
+      
+      def matches?(actual)
+        @actual = actual
+        actual.gsub(/<(.|\n)+?>/,'').size.should <= @size
+      end
+    end
+
+    def be_summarizable_of(size)
+      SummarizableOf.new(size)
+    end
+  end
+end
+
+begin
+  require 'spec'
+  Spec::Runner.configure { |config| config.include(Summary::Matchers) }
+rescue LoadError
+  require 'rspec'
+  RSpec.configure { |config| config.include(Summary::Matchers) }
+end

data/spec/summary_spec.rb

@@ -0,0 +1,217 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Summary do
+  it 'should be version 0.6.0' do
+    subject::VERSION.should == '0.6.0'
+  end
+end
+
+describe Summary, 'on plain text' do
+  before do
+    @text = 'Cras eleifend sodales sem. Ut nec metus. Nulla sed nisl. Praesent malesuada dui rhoncus quam. Aliquam ultricies. Praesent commodo. Nam nec pede. Pellentesque egestas, urna vel accumsan venenatis, mi metus sagittis augue, sed hendrerit nunc felis eget neque. Fusce vel massa. Quisque ligula enim, tempor sed, lacinia non, malesuada ac, enim. Curabitur at enim scelerisque neque egestas luctus. Mauris lacinia varius diam.'
+  end
+  
+  context "by default" do
+    before do
+      @summarized = @text.summary
+    end
+    
+    it 'should break the text' do
+      @summarized.should == 'Cras eleifend sodales sem. Ut nec metus. Nulla sed nisl. Praesent malesuada dui rhoncus quam...'
+    end
+    
+    it "should have 100 chars" do
+      @summarized.should be_summarizable_of(100)
+    end
+  end
+  
+  context "limited to 50 chars" do
+    before do
+      @summarized = @text.summary(50)
+    end
+    
+    it "should break the text" do
+      @summarized.should == 'Cras eleifend sodales sem. Ut nec metus. Nulla...'
+    end
+    
+    it "should have 50 chars" do
+      @summarized.should be_summarizable_of(50)
+    end
+  end
+end
+
+
+describe Summary, 'on html' do
+  before do
+    @text = 'Cras <strong>eleifend sodales sem</strong>. <img src="image.jpg" /><h1>Ut</h1> nec metus. <br />Nulla sed<p> nisl. Praesent malesuada</p> dui rhoncus quam. Aliquam ultricies. Praesent commodo. Nam nec pede. Pellentesque egestas, urna vel accumsan venenatis, mi metus sagittis augue, <strong>sed</strong> hendrerit nunc felis eget neque. Fusce vel massa. Quisque ligula enim, tempor sed, lacinia non, malesuada ac, enim. Curabitur at enim scelerisque neque egestas luctus. Mauris lacinia varius diam.'
+  end
+  
+  context "by default" do
+    before do
+      @summarized = @text.summary
+    end
+    
+    it "should break the text" do
+      @summarized.should == 'Cras eleifend sodales sem. Ut nec metus. Nulla sed nisl. Praesent malesuada dui rhoncus quam...'
+    end
+    
+    it "should have 100 chars" do
+      @summarized.should be_summarizable_of(100)
+    end
+  end
+  
+  context "limited to 50 chars" do
+    before do
+      @summarized = @text.summary(50)
+    end
+    
+    it "should break the text" do
+      @summarized.should == 'Cras eleifend sodales sem. Ut nec metus. Nulla...'
+    end
+    
+    it 'should have 50 chars' do
+      @summarized.should be_summarizable_of(50)
+    end
+  end
+end
+
+describe Summary, 'on complex text' do
+  before do
+    @text = <<-BREAK
+      Cras <strong>eleifend sodales sem</strong>. 
+      
+      <img src="image.jpg" /><h1>Ut</h1> nec metus. 
+      <br />Nulla sed<p> nisl. Praesent malesuada</p> dui rhoncus quam. Aliquam ultricies. 
+      
+      Praesent commodo. Nam nec pede. Pellentesque egestas, urna vel accumsan venenatis, mi metus sagittis augue, <strong>sed</strong> hendrerit nunc felis eget neque. Fusce vel massa. Quisque ligula enim, tempor sed, lacinia non, malesuada ac, enim. Curabitur at enim scelerisque neque egestas luctus. Mauris lacinia varius diam.
+    BREAK
+  end
+  
+  context "by default" do
+    before do
+      @summarized = @text.summary
+    end
+    
+    it "should break the text" do
+      @summarized.should == 'Cras eleifend sodales sem. Ut nec metus. Nulla sed nisl. Praesent malesuada dui rhoncus quam...'
+    end
+    
+    it 'should have 100 chars' do
+      @summarized.should be_summarizable_of(100)
+    end
+  end
+  
+  context "limited to 50 chars" do
+    before do
+      @summarized = @text.summary(50)
+    end
+    
+    it "should break the text" do
+      @summarized.should == 'Cras eleifend sodales sem. Ut nec metus. Nulla...'
+    end
+    
+    it 'should have 50 chars' do
+      @summarized.should be_summarizable_of(50)
+    end
+  end
+end
+
+describe Summary, 'on tiny text' do
+  before do
+    @text = 'Praesent commodo. Nam nec pede. Pellentesque egestas, urna vel accumsan venenatis.'
+  end
+  
+  context "by default" do
+    before do
+      @summarized = @text.summary
+    end
+    
+    it "should not break the text" do
+      @summarized.should == 'Praesent commodo. Nam nec pede. Pellentesque egestas, urna vel accumsan venenatis.'
+    end
+    
+    it "should have 100 chars" do
+      @summarized.should be_summarizable_of(100)
+    end
+  end
+  
+  context "limited to 50 chars" do
+    before do
+      @summarized = @text.summary(50)
+    end
+    
+    it "should break the text" do
+      @summarized.should == 'Praesent commodo. Nam nec pede. Pellentesque...'
+    end
+    
+    it "should have 50 chars" do
+      @summarized.should be_summarizable_of(50)
+    end
+  end
+end
+
+
+describe Summary, 'with different terminators' do
+  before do
+    @text = 'Cras eleifend sodales sem. Ut nec metus. Nulla sed nisl. Praesent malesuada dui rhoncus quam. Aliquam ultricies. Praesent commodo. Nam nec pede. Pellentesque egestas, urna vel accumsan venenatis, mi metus sagittis augue, sed hendrerit nunc felis eget neque. Fusce vel massa. Quisque ligula enim, tempor sed, lacinia non, malesuada ac, enim. Curabitur at enim scelerisque neque egestas luctus. Mauris lacinia varius diam.'
+  end
+  
+  context "limited to 50 chars" do
+    context "with !" do
+      before do
+        @summarized = @text.summary(50, '!')
+      end
+
+      it "should end with !" do
+        @summarized.should == 'Cras eleifend sodales sem. Ut nec metus. Nulla!'
+      end
+
+      it "should have 50 chars" do
+        @summarized.should be_summarizable_of 50
+      end
+    end
+    
+    context "with ." do
+      before do
+        @summarized = @text.summary(50, '.')
+      end
+      
+      it "should end with ." do
+        @summarized.should == 'Cras eleifend sodales sem. Ut nec metus. Nulla.'
+      end
+      
+      it "should have 50 chars" do
+        @summarized.should be_summarizable_of(50)
+      end
+    end
+    
+    context "with nothing" do
+      before do
+        @summarized = @text.summary(50, '')
+      end
+      
+      it 'should end with nothing' do
+        @summarized.should == 'Cras eleifend sodales sem. Ut nec metus. Nulla sed'
+      end
+      
+      it "should have 50 chars" do
+        @summarized.should be_summarizable_of(50)
+      end
+    end
+    
+    context "with html" do
+      before do
+        @summarized = @text.summary(50, '... <a href="#read-more">read more</a>')
+      end
+      
+      it "should end with ...<a href=\"#read-more\">read more</a>" do
+        @summarized.should == 'Cras eleifend sodales sem. Ut nec... <a href="#read-more">read more</a>'
+      end
+      
+      it "should have 50 chars" do
+        @summarized.should be_summarizable_of(50)
+      end
+    end
+  end
+end
+

data/summary.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{summary}
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bruno Azisaka Maciel"]
+  s.cert_chain = ["/Users/Bruno/.certs/gem-public_cert.pem"]
+  s.date = %q{2010-07-09}
+  s.description = %q{This is a simple gem that generates introduction text from a long text, it will always break the text at the end of the last word near to the limit you informed as argument.}
+  s.email = %q{bruno [at] bubble [dot] com [dot] br}
+  s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "lib/summary.rb"]
+  s.files = ["CHANGELOG", "Manifest", "README.rdoc", "Rakefile", "lib/summary.rb", "rails/init.rb", "spec/spec_helper.rb", "spec/summary_spec.rb", "summary.gemspec"]
+  s.homepage = %q{http://github.com/azisaka/summary}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Summary", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{summary}
+  s.rubygems_version = %q{1.3.7}
+  s.signing_key = %q{/Users/Bruno/.certs/gem-private_key.pem}
+  s.summary = %q{This is a simple gem that generates introduction text from a long text, it will always break the text at the end of the last word near to the limit you informed as argument.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: summary
+version: !ruby/object:Gem::Version 
+  hash: 7
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
+platform: ruby
+authors: 
+- Bruno Azisaka Maciel
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDVjCCAj6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBRMQ4wDAYDVQQDDAVicnVu
+  bzEWMBQGCgmSJomT8ixkARkWBmJ1YmJsZTETMBEGCgmSJomT8ixkARkWA2NvbTES
+  MBAGCgmSJomT8ixkARkWAmJyMB4XDTEwMDcwOTAzMDgzMloXDTExMDcwOTAzMDgz
+  MlowUTEOMAwGA1UEAwwFYnJ1bm8xFjAUBgoJkiaJk/IsZAEZFgZidWJibGUxEzAR
+  BgoJkiaJk/IsZAEZFgNjb20xEjAQBgoJkiaJk/IsZAEZFgJicjCCASIwDQYJKoZI
+  hvcNAQEBBQADggEPADCCAQoCggEBALtBRcHEtEyyr7zSrkS37jKiPEWiKZZhbTZH
+  5Yy7x2RA4DI6aUzGWVJ5IE18kdFuGu5rZ1k6Wcf2dGELAs7Os7MeWxXaCvmmJDHa
+  4eR6iFjfqAqocU927YIjOClBABWnJghDW7QqxgFvHYMVRj2/WgrHx8mUbZp0RJkU
+  IlWi4RVEpRhJghKvD5zBaVUqDO8fdgLls21g/j/ouLCPfqvuh90dxR1uiDa89JPE
+  EbOVJPGgceZL7FnVPQokPWS4jTAkm0nKpmElOU1vggplY+qULDAusufWDS6YlAsb
+  o0my/uovLSkzqHPeXgMgUgxafycD2NEUz0L0Zi0+41/8+7KT25MCAwEAAaM5MDcw
+  CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJyLvNXo0jpfTs0oRrsr
+  ZJ64XDKJMA0GCSqGSIb3DQEBBQUAA4IBAQCssdnvIqs6+DnfVb4SCAsAgzECIFTx
+  dKX39I17hMRhb9K0yvDXsA++LIVQfMuvnR3oVaP8blRdGMyRIB+QPEBcCJiW1Ljp
+  vuAgyiicxDjoikfwONWISxeW64LHqJGRvxZOMtxWGd7Vsc655hJUoOBnK2Vi5rKx
+  1FO4o7EKd+KD1emJtoTmKS0B7fuszwy3ux6H9kRBtNtjKhvvu4AB7gXS5b0ypSz6
+  QCNVuBCPE7+WCKOZZ8Dk6I99EHFlHQmIcnxMbs/tQRJ5cP/PET9k9WH3jTY+MNs2
+  Qk3muzkQzffuq2/7M5zVVnmOi8M1z563OJCOKtDpzVoeXYNoVIZSpgY7
+  -----END CERTIFICATE-----
+
+date: 2010-07-09 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: This is a simple gem that generates introduction text from a long text, it will always break the text at the end of the last word near to the limit you informed as argument.
+email: bruno [at] bubble [dot] com [dot] br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- README.rdoc
+- lib/summary.rb
+files: 
+- CHANGELOG
+- Manifest
+- README.rdoc
+- Rakefile
+- lib/summary.rb
+- rails/init.rb
+- spec/spec_helper.rb
+- spec/summary_spec.rb
+- summary.gemspec
+has_rdoc: true
+homepage: http://github.com/azisaka/summary
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Summary
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: summary
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This is a simple gem that generates introduction text from a long text, it will always break the text at the end of the last word near to the limit you informed as argument.
+test_files: []
+

metadata.gz.sig

@@ -0,0 +1,3 @@
+��8������߀_Lnvi���#��:����F'P��p{R�%/0qP��&'�}J	��W��U�g�v�:.8
+ç�Q����H6�M�Q��j�yH��U�O��I�!�
+]M�;�/��\C#�̽��������}��n�~Co�q� +�g