truncate_html 0.3.0 → 0.3.1

data/History.txt

@@ -1,3 +1,7 @@
+== 0.3.0 2010-02-02
+  * Added the ability to set global configuration parameters
+  * Added the word_boundry option
+
 == 0.2.2 2009-12-23
  * Fix issue #4: Handle case when supplied length is smaller than omission. (ghazel)
 

data/README.markdown

@@ -15,14 +15,25 @@ Example
 
 A few notes:
 
-* The default options are:
-  * :length => 100
-  * :omission => '...'
-* By default, it will truncate on word boundry. 
-  To truncate the HTML string strictly at the specified length, pass in the `:word_boundry => false` option.
+* By default, it will truncate on word boundary.
+  To truncate the HTML string strictly at the specified length, pass in the `:word_boundary => false` option.
 * If the input HTML is nil, it will return an empty string.
 * The omission text's length does count toward the resulting string's length.
 * `<script>` tags will pass right through - they will not count toward the resulting string's length, or be truncated.
+* The default options are:
+  * :length => 100
+  * :omission => '...'
+  * :word_boundary => true
+
+You may also set global configuration options.
+For example, place the following on a sensible place,
+like `config/initializers/truncate_html.rb`
+
+    TruncateHtml.configure do |config|
+      config.length       = 50
+      config.omission     = '...(continued)'
+      config.word_boundary = false
+    end
 
 Installation
 ------------
@@ -41,10 +52,10 @@ or
 #### As a plugin:
 <code>script/plugin install git://github.com/hgimenez/truncate_html.git</code>
 
-Issues
-------
+Issues or Suggestions
+---------------------
 
-Found an issue? Please report it on [Github's issue tracker](http://github.com/hgimenez/truncate_html/issues).
+Found an issue or have a suggestion? Please report it on [Github's issue tracker](http://github.com/hgimenez/truncate_html/issues).
 
 Testing
 -------

data/Rakefile

@@ -43,7 +43,7 @@ begin
     gem.description = %Q{Truncates html so you don't have to}
     gem.email = "harold.gimenez@gmail.com"
     gem.homepage = "http://github.com/hgimenez/truncate_html"
-    gem.authors = ["hgimenez"]
+    gem.authors = ["Harold A. Gimenez"]
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/init.rb

@@ -3,5 +3,5 @@ require 'truncate_html'
 TruncateHtml.configure do |config|
   config.length       = 100
   config.omission     = '...'
-  config.word_boundry = true
+  config.word_boundary = true
 end

data/lib/truncate_html/configuration.rb

@@ -1,6 +1,6 @@
 module TruncateHtml
   class Configuration
-    attr_accessor :length, :omission, :word_boundry
+    attr_accessor :length, :omission, :word_boundary
   end
 
   class << self

data/lib/truncate_html/html_truncator.rb

@@ -8,7 +8,7 @@ module TruncateHtml
     def truncate(options = {})
       length        = options[:length]       || TruncateHtml.configuration.length
       @omission     = options[:omission]     || TruncateHtml.configuration.omission
-      @word_boundry = (options.has_key?(:word_boundry) ? options[:word_boundry] : TruncateHtml.configuration.word_boundry)
+      @word_boundary = (options.has_key?(:word_boundary) ? options[:word_boundary] : TruncateHtml.configuration.word_boundary)
       @chars_remaining = length - @omission.length
       @open_tags, @truncated_html = [], ['']
 
@@ -35,12 +35,12 @@ module TruncateHtml
             remove_latest_open_tag(token)
           end
         else
-          @chars_remaining -= (@word_boundry ? token.length : token[0, @chars_remaining].length)
+          @chars_remaining -= (@word_boundary ? token.length : token[0, @chars_remaining].length)
         end
       end
 
       def append_to_result(token)
-        if @word_boundry
+        if @word_boundary
           @truncated_html << token
         else
           @truncated_html << token[0, @chars_remaining]

data/spec/truncate_html/html_truncator_spec.rb

@@ -9,9 +9,9 @@ describe TruncateHtml::HtmlTruncator do
 
   describe '#truncate' do
 
-    context 'when the word_boundry option is set to false' do
+    context 'when the word_boundary option is set to false' do
       it 'truncates to the exact length specified' do
-        truncate('<div>123456789</div>', :length => 5, :omission => '', :word_boundry => false).should == '<div>12345</div>'
+        truncate('<div>123456789</div>', :length => 5, :omission => '', :word_boundary => false).should == '<div>12345</div>'
       end
     end
 

data/truncate_html.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{truncate_html}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["hgimenez"]
-  s.date = %q{2010-02-02}
+  s.authors = ["Harold A. Gimenez"]
+  s.date = %q{2010-02-03}
   s.description = %q{Truncates html so you don't have to}
   s.email = %q{harold.gimenez@gmail.com}
   s.extra_rdoc_files = [

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: truncate_html
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
-- hgimenez
+- Harold A. Gimenez
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-02-02 00:00:00 -05:00
+date: 2010-02-03 00:00:00 -05:00
 default_executable: 
 dependencies: []